Amiga ISO Collection/AmigaDemoCD2.iso/ASCII/TEXTE/SCENE/AMIGA/DOS Commands.txt

Text File | 1992-09-02 | 163.0 KB | 5,059 lines

AMIGA DOS 3.0 COMMANDS


ADDBUFFERS


Format:            ADDBUFFERS <drive> [<n>]
Template:            DRIVE/A, BUFFERS/A
Purpose:            To instruct the file system to add cache buffers.
Path:            C:ADDBUFFERS
Spesifications:

ADDBUFFERS adds <n> buffers to the list of buffers available for
<drive>. Allocating additional buffers makes disk access significantly
faster. However, each additional buffer reduces free memoty by
approximately 500 bytes. The default buffer allocation is 5 for floppy
dives and 30 for hard disks.

The number of buffers you should add depends on the amount of extra
memory available. There is no fixed upper limit, but adding too many
buffers can actually reduce overall system performance by taking RAM
away form other system functiones. If a negative number is spesified,
that many buffers is subtracted form the current acollation. The
minimum number of buffers is one; however, using only one is not
recommended.

Thirty buffers are generally recommended for a floppy drivein a 512KB
system. The optimal number for a hard disk depends on the type and size
of your drive. Usually you should use the default value recommended by
the HDToolbox program. (This value can be displayed by selecting the
Advanced Options gadget on the Partitioning screen.) As a general rule,
you can use 30 to 50 buffers for every megabyte of disk storage in your
system.

If only the <drive> argument is specified, ADDBUFFERS displays the
number of buffers currently allocated for that drive.


Example 1:

    1> ADDBUFFERS DF0:
    DF0: has 5 buffers

Displays the number of buffers currently allocated to drive df0:.


Example 2:

    1> ADDBUFFERS DF1: 25
    DF1: HAS 30 BUFFERS

Adds 25 buffers to drive df1: and displays the total.
ADDDATATYPES


Format:            ADDDATATYPES {FILES} [QUIET] [REFRESH]
Template:            FILES/M, QUIET/S, REFRESH/S
Purpose:            To build a list of data types that
                datatypes.library can understand.
Path:            C:ADDDATATYPES
Specification:

ADDDATATYPES is used by datatypes.library to build a list of data types
than it can understand. DataType descriptors are stored in
DEVS:DataTypes.

ADDDATATYPES can also be called by application Installation scripts to
add their own data types to the list. Basically, ADDDATATYPES is not a
user program.

The FILES option specifies the name(s) of the DataType descriptors to
add to the list of DataType descriptors.

The QUIET option, if specified, will surpress error and output
messages.

The REFRESH option, is specified, will scan the DEVS:DataTypes
directory for new or changed DataType descriptors.

ADDDATATYPES is valid on Workbench 3.0 level software.
ALIAS


Format:            ALIAS [<name>] [<string>]
Template:            NAME, STRING/F
Purpose:            To set or display command aliases.
Path:            Internal
Specification:

ALIAS permits you to create aliases, or alternative names, for AmigaDOS
commands. Using an alias is like replacing a sentence with a single
word. With ALIAS, you can abbreviate frecuently used commands or
replace a standard command name with a different name.

When AmigaDOS encounters <name>, it replaces it with the defined
<string>, integrates the result with the rest of the command line, and
attempts to interpret and execute the resulting line as an AmigaDOS
command. So <name> is the alias (whatever you want to call the
command), and <string> is the command to be substituted for the alias.

An alias must be entered at the beginning of the command line. You can
enter arguments after the alias. However, you cannot create an alias to
represent a series of command arguments. For example, in the following
command line:

    1> LIST PicDir TO RAM:filelist
    LFORMAT="SYS:Utilities/display %f%n"

you could not replace the LFORMAT argument with an alias. You
can substitute a filename or other instruction within an alias by
placing square brackets ([ ]) in the <string>. Any argument entered
after the alias will be inserted at the brackets.

ALIAS <name> displays the <string> for that alias. ALIAS alone
lists all current aliases.

Aliases are local to the Shell in which they are defined. If you
create another Shell with the NEWSHELL command, it will share
the same aliases as its parent Shell. However, if you create another
Shell with the Execute Command menu item, it will not recognize
aliases created in your original Shell. To create a global alias that
will be recognized by all Shells, insert the alias in the Shell-startup
file.

To remove an ALIAS, use the UNALIAS command.


Example 1:

    1> ALIAS d1 DIR DF1:

Entering d1 results in a directory of the contents of the disk in
DF1:, just as ifyou had entered DIR DF1:.
Example 2:

    1> ALIAS hex TYPE [] HEX NUMBER

creates an alias called hex that displays the contents of a specifed
fle in hexadecimal format. The brackets indicate where the
flename will be inserted. If you then entered:

    1> hex Myfile

the contents of Myfile would be displayed in hexadecimal format
with line numbers.


See also: UNALIAS
ASK


Format:            ASK <prompt>
Template:            PROMPT/A
Purpose:            To obtain user input when executing a script fle.
Path:            Internal
Specification:

ASK is used in scripts to write the string specifed by <prompt> to
the current window then wait for keyboard input. Valid keyboard
responses are Y (yes), N (no), and Return (no). If Y is pressed, ASK
sets the condition flag to 5 (WARN). If N or Return is pressed, the
condition flag is set to 0. To check the response, an IF statement
can be used.

If the <prompt> contains spaces, it must be enclosed in quotation
marks.

Example:

Assume a script contained the following commands:

    ASK Continue?
    IF WARN
        ECHO Yes
    ELSE
        ECHO No
    ENDIF

When the ASK command is reached, "Continue?" will appear on the
screen. If Y is pressed, Yes will be displayed on the screen. If N is
pressed, No will be displayed.

See also: IF, ELSE, ENDIF, WARN
ASSIGN


Format:ASSIGN [<name>: {dir}] [LlST] [EXlSTS] [DlSMOUNT]
[DEFER] [PATH] [ADD] [REMOVE] [VOLS] [DlRS]
[DEVlCES]
Template:NAME, TARGET/M, LlST/S, EXlSTS/S, DlSMOUNT/S,
DEFER/S, PATH/S, ADD/S, REMOVE/S, VOLS/S, DlRS/S,
DEVlCES/S
Purpose:To control assignment oflogical device names to
file system directories.
Path:            C:ASSlGN
Specifcation:


ASSIGN allows directories to be referenced via short, convenient
logical device names rather than their usual names or complete
paths. The ASSIGN command can create assignments, remove
assignments, or list some or all current assignments.

If the <name> and {dir} arguments are given, ASSIGN will assign
the given name to the specified directory. Each time the assigned
logical device name is referred to, AmigaDOS will access the
specified directory. If the <name> given is already assigned to a
directory, the new directory will replace the previous directory.
(Always be sure to include a colon after the <name> argument.)

If only the <name> argument is given, any existing ASSIGN of a
directory to that logical device will be cancelled.

You can assign several logical device names to the same directory by
using multiple ASSIGN commands.

You can assign one logical device name to several directories by
specifying each directory after the <name> argument or by using the ADD
option. When the ADD option is specified, any existing directory
assigned to <name> is not cancelled. Instead, the newly specified
directory is added to the ASSIGN list, and the system will search for
both directories when <name> is encountered. If the original directory
is not available, ASSIGN will be satisfied with the newly added
directory.

To delete a name from the ASSIGN list, use the REMOVE option.

If no arguments are given with ASSIGN, or if the LIST keyword is used,
a list of all current assignments will be displayed. If the VOLS, DIRS,
or DEVICES switch is specified, ASSIGN will limit the display to
volumes, directories, or devices, respectively.

When the EXISTS keyword is given along with a logical device name,
AmigaDOS will search the ASSIGN list for that name and display the
volume and directory assigned to that device. If the device name is not
found, the condition flag is set to 5 (WARN). This is commonly used in
scripts.
Normally, when the (dir) argument is given, AmigaDOS immediately looks
for that directory. If the ASSIGN commands are part of the
Startup-sequence, the directories need to be present on a mounted disk
during the boot procedure. If an assigned directory cannot be found, a
requester appears asking for the volume containing that directory.
However, two new options, DEFER and PATH, will wait until the directory
is actually needed before searching for it.

The DEFER option creates a "late-binding" ASSIGN. This ASSIGN
only takes effect when the assigned object is first referenced, rather
than when the assignment is made. This eliminates the need to
insert disks during the boot procedure that contain the directories
that are assigned during the Startup-sequence. When the DEFER
option is used, the disk containing the assigned directory is not
needed until the object is actually called upon. The assignment
remains in force until explicitly changed.

For example, if you ASSIGN FONTS: to DF0:Fonts with the DEFER
option, the system will associate FONTS: with whatever disk is in
DF0: at the time FONTS: is called. If you have a Workbench disk in
DF0: at the time the FONTS: directory is needed, the system will
associate FONTS: with that particular Workbench disk. If you later
remove that Workbench disk and insert another disk containing a
FONTS: directory, the system will specifically request the original
Workbench disk the next time FONTS: is needed.

It is not necessary for the assigned name to retain the name of the
directory nor is it necessary for it to be uppercase. For example,
both CLIPS and Clips can be assigned to the Ram Disk:Clipboards
directory.

The PATH option creates a "non-binding" ASSIGN. A non-binding ASSIGN
acts like a DEFERred ASSIGN except that it is re-evaluated each time
the assigned name is referenced. This prevents the system from
expecting a particular volume in order to use a particular directory
(such as the situation described in the example above). For example,
ifyou assign FONTS: to DFO:Fonts with the PATH option, any disk in DF0:
will be searched when FONTS: is referenced. As long as the disk
contains a FONTS: directory, it will satisfy the ASSIGN. You cannot
assign multiple directories with the PATH option.

The PATH option is especially useful to users with floppy disk systems
as it eliminates the need to reinsert the original Workbench disk used
to boot the system. As long as the drive you have assigned with the
PATH option contains a disk with the assigned directory name, the
system will use that disk. The DISMOUNT option disconnects a volume or
device from the list of mounted devices. It does not free up resources;
it merely removes the name from the list. There is no way to cancel a
DISMOUNT without rebooting. DISMOUNT is primarily for use during
software development. Careless use of this option may cause a software
failure.
Example 1:

    1> ASSIGN FONTS: MyFonts:Fontdir

assigns the FONTS: directory to Fontdir on MyFonts:.


Example 2:

    1>  ASSIGN  LIST
    Volumes:
    Ram Disk [Mounted]
    Workbench [Mounted]
    MyFonts [Mounted]

    Directories:
    LOCALE    Workbench:Locale
    KEYMAPS    Workbench:Devs/Keymaps
    PRINTERS    Workbench:Devs/Printers
    REXX        Workbench:S
    CLIPS    Ram Disk:Clipboards
    ENV        Ram Disk:Env
    T        Ram Disk:T
    ENVARC    Workbench:Prefs/Env-Archive
    SYS        Workbench:
    C        Workbench:C
    S        Workbench:S
    L        Workbench:L
    FONTS    MyFonts:Fontdir
    DEVS        Workbench:Devs
    LIBS        Workbench:Libs

    Devices:
    PIPE AUX RAM CON
    RAW PAR SER PRT DFO DF1

shows a list of all current assignments.


Example 3:

    1>  ASSIGIV  FONTS:  EXISTS
    FONTS: MyFonts:FontDir

is an inquiry into the assignment of FONTS:. AmigaDOS responds
by showing that FONTS: is assigned to the FontDir directory of the
MyFonts volume.


Example 4:

    1> ASSIGN LIBS: SYS:Libs BigAssem:Libs PDAssem:Libs

is a multiple-directory assignment that creates a search path
containing three Libs directories. These directories will be searched
in sequence each time LIBS: is invoked.
Example 5:

    1>  ASSIGN DEVS:  REMOVE

removes the DEVS: assignment from the system.


Example 6:

    1> ASSIGN WorkDisk: DF0: DEFER
    1> ASSIGN WorkDisk: EXISTS
    WorkDisk <DF0:>

sets up a late-binding assignment of the logical device WorkDisk:.
The disk does not have to be inserted in DF0: until the first time
you refer to the name WorkDisk:. Notice that ASSIGN shows DF0:
enclosed in angle brackets to indicate that it is DEFERred. After
the first reference to WorkDisk:, the volume name of the disk that
was in DF0: at the time will replace <DF0:>.


Example 7:

    1>  ASSIGN C: DF0:C PATH
    1>  ASSIGN C: EXISTS
    WorkDisk <DF0:>

will reference the C directory of whatever disk is in DF0: at the time
a command is searched for. Notice that ASSIGN shows DFO:C in
square brackets to indicate that it is a non-binding ASSIGN.


Example 8:
1> ASSIGN LIBS: ZCad:Libs ADD

adds ZCad:Libs to the list ofdirectories assigned as LIBS:.


Example 9:
1> ASSIGN LIBS: ZCad:Libs REMOVE

removes ZCad:Libs from the list of directories assigned as LIBS:.
AUTOPOINT


Format:            AUTOPOINT [CX_PRIORITY <priority>]
Template:            CX_PRlORlTY/N/K
Purpose:To automatically select any window the pointer is
over.
Path:            Extras:Tools/Commodities/AutoPoint
Specification:

When AUTOPOINT is run, any window that the pointer is over is
automatically selected. You do not need to click the selection button
to activate it.

The CX_PRIORITY <priority> argument sets the priority of AutoPoint in
relation to all the other Commodity Exchange programs. (This is the
same as entering a CX_PRIORITY=<priority> Tool Type in the icon's
Information window.) All the Commodity Exchange programs are set to a
default priority of 0. If you specify a <priority> value higher than 0,
AutoPoint will take priority over any other Commodity Exchange program.

To exit AutoPoint when it has been started from a Shell, press Ctrl+C
or use the BREAK command.


Example:

    1> AUTOPOINT

starts the AutoPoint program.
AVAIL


Format:            AVAIL [CHlP|FAST|TOTAL] [FLUSH]
Template:            CHlP/S, FAST/S, TOTAL/S, FLUSH/S
Purpose:To report the amount of CHIP and FAST memory
available.
Path:            C:AVAlL
Specification:

AVAIL gives a summary of the system RAM, both CHIP and FAST. For each
memory type, AVAIL reports the total amount of memory, how much is
available, how much is currently in use, and the largest contiguous
memory block not yet allocated.

By using the CHIP, FAST and/or TOTAL options, you can have AVAIL
display only the number of free bytes of CHIP, FAST or TOTAL RAM
available, instead of the complete summary. This value can be used for
comparisons in scripts.

The FLUSH option causes all unused libraries, devices, and fonts to be
expunged from memory.


Example l:

    1> AVAIL
    Type        Available        In-Use    Maximum    Largest
    chip           233592        282272     515864      76792
    fast           341384        182896     524280     197360
    total       574976        465168    1040144     197360

A complete summary of system RAM is displayed.


Example 2:

    1> AVAIL CHIP
    233592

The number of free bytes of CHIP RAM is displayed.
BINDDRIVERS


Format:            BINDDRIVERS
Template:            (none)
Purpose:            To bind device drivers to hardware.
Path:            C:BlNDDRlVERS
Specification:

BINDDRIVERS is used to load and run device drivers for add-on hardware
that is automatically configured by the expansion library. The device
drivers must be in the SYS:Expansion directory for BINDDRIVERS to find
them.

BINDDRIVERS is normally placed in the Startup-sequence file. If drivers
for expansion hardware are in the Expansion directory, you must have a
BINDDRIVERS command in your Startup-sequence or the hardware will not
be configured when the system is booted.
BLANKER


Format:BLANKER [CX_PRIORITY <priority>] [CX_POPKEY <key>]
[CX_POPUP=<yes|no>) [SECONDS <timeout>]
[CYCLECOLORS <yes|no>] [ANlMATlON <yes|no>]
Template:CX PRlORlTY/N/K, CX POPKEY/K, CX POPUP/K,
SECONDS/N/K, CYCLECOLORS/K, ANlMATlON/K
Purpose:To cause the monitor screen to go blank if no input
has been received within a specified period of time
Path:            Extras:Tools/Commodities/Blanker
Specification:

BLANKER is a Commodity Exchange program that causes the
screen to go blank if no mouse or keyboard input has been received
in the specified number of seconds. The SECONDS argument
allows you to specify the number of seconds that must pass. The
acceptable range is from 1 to 9999. Default is 60 seconds.

CX_POPKEY allows you to specify the hot key for the program. If more
than one key is specified, be sure to enclose the entire argument in
double-quotes (i.e., CX_POPKEY="Shift F1").

CX_POPUP=no will prevent the Blanker window from opening. (By default
the program window opens when the command is invoked.)

CX_PRIORITY sets the priority of Blanker in relation to all other
Commodity Exchange programs. All the Commodity Exchange programs are
set to a default priority of 0.

If CYCLECOLORS=yes is specified, Blanker will cycle through a series of
colors. If CYCLECOLORS=no is specified, Blanker will display the
default color.

If ANIMATION=yes is specified, the screen will display a series of
random splines. If ANIMATION=no is specified, a blank screen will
appear.

To exit Blanker when it has been started through the Shell, press
Ctrl+C or use the BREAK command.


Example 1:

    1> BLANKER SECONDS=45

The Blanker window will open, and 45 will be displayed inside its text
gadget. If no mouse or keyboard input is received during a 45 second
interval, the screen will go blank.


Example 2:

    1> BLANKER CX_POPUP=no

The Blanker program will start. If no input is received within 60
seconds (the default), the screen will go blank. The Blanker window
will not open.
BREAK


Format:            BREAK <process> [ALL|C|D|E|F]
Template:            PROCESS/A/N, ALL/S, C/S, D/S, E/S, F/S
Purpose:            To set attention flags in the specified process.
Path:            C:BREAK
Specification:

BREAK sets the specified attention flags in the <process> indicated.
Use the STATUS command to display the currrent process numbers. C sets
the Ctrl+C flag, D sets the Ctrl+D flag, and so on. ALL sets all the
flags from Ctrl+C to Ctrl+F. By default, only the Ctrl+C flag is set.

The action of BREAK is identical to selecting the relevant process by
clicking in its window and pressing the appropriate Ctrl+key
combination(s).

Ctrl+C is used as the default for sending a BREAK signal to halt a
process. A process that has been aborted this way will display ***BREAK
in the Shell window. Ctrl+D is used to halt execution of a script file.
Use the STATUS command to display the current process numbers.

Ctrl+F is used by programs that open windows. Sending these programs a
Ctrl+F signal will cause them to activate their window and bring it to
the front of all windows. Not all programs respond to Ctrl+F.


Example 1 :

    1> BREAK 7

sets the Ctrl+C attention flag of process 7. This is identical to
selecting process 7 and pressing Ctrl+C.


Example 2:

    1> BREAK 5 D

sets the Ctrl+D attention flag of process 5.


See also: STATUS
CALCULATOR


Format:CALCULATOR [PUBSCREEN <public screenname>] [TAPE
<window>]
Template:            PUBSCREEN, TAPE/K
Purpose:            To provide an on-screen calculator.
Path:            Extras:Tools/Calculator
Specification:

CALCULATOR starts the Calculator program. You can cut and paste the
output of the Calculator into any console window, like the Shell or ED.

TAPE allows you to create a Calculator window of a specific size in
which to display your input and output. The specification is in the
form of:
TAPE=RAW:x/y/width/height/title/options

where:
      xIs the number of pixels from the left edge of the screen
to the left border of the window.
      yIs the number of pixels from the top of the screen to
the top of the window.
      width    Is the width of the window, in pixels.
      height    Is the height of the window, in pixels.
      title    Is the text that appears in the window title bar.

The permissible options are:

AUTOThe window automatically appears when the program needs input
or produces output. With the Shell window, it will open for
input immediately. The window can only be closed with the
ENDSHELL command. Selecting the Shell's close gadget will
close the window, but it will re-open immediately since it is
expecting input.

CLOSEThe window has all the standard gadgets, including a close
gadget.

BACKDROPThe window appears on the backdrop, behind all the Workbench
windows. The only gadget in the window border is the zoom
gadget. This Shell window cannot be brought to the front of
the screen; you have to resize the Workbench windows to see
it.

NOBORDERThe window opens without any left or bottom window border.
Only the zoom, depth, and sizing gadgets are available.

NODRAGThe window cannot be dragged. It has a zoom, depth and sizing
gadget, but no close gadget.

NOSIZEThe window only has a depth gadget.

SCREENThe window will open on a public screen. The screen must
already exist. You must specify the name of the screen after
the SCREEN keyword.
SIMPLEIf you enlarge the window, the text will expand to fill the
newly available space, allowing you to see text that had been
scrolled out of the window.

SMARTIf you enlarge the window, the text does not expand to fill
the newly available space.

WAITThe window can only be closed by selecting the close gadget.
(An example of this is the Execute Command Workbench Output
Window.)


To exit the program, select the window's close gadget.

Example:

    1> CALCULATOR
CD


Format:        CD [<dir|pattern>]
Template:      DIR
Purpose:       To set, change, or display the current directory.
Path:          Internal
Specification:

CD with no arguments displays the name of the current directory. When a
valid directory name is given, CD makes the named directory the current
directory.

CD does not search through the disk for the specified directory. It
expects it to be in the current directory. If it is not, you must give
a complete path to the directory. If CD cannot find the specified
directory in the current directory or in the given path, a Can't find
<directory> error message is displayed.

If you want to move up a level in the filing hierarchy to the parent
directory of the current directory, enter CD followed by a space and a
single slash (/). Moving to another directory in the parent can be done
at the same time by including its name after the slash. If the current
directory is a root directory, CD / will have no effect. Multiple
slashes are allowed; each slash refers to an additional higher level.
When using multiple slashes, leave no spaces between them.

To move directly to the root directory of the current device, use CD
followed by a space and a colon, i.e., CD :.

CD also supports pattern matching. If more than one directory matches
the given pattern, an error message is displayed.


Example 1:

    1> CD DF1:Work

sets the current directory to the Work directory on the disk in drive
DF1:.


Example 2:

    1> CD SYS:Com/Basic

makes the subdirectory Basic in the Com directory the current
directory.


Example 3 :

    1> CD //

moves up two levels in the directory structure.
Example 4:

    1> CD SYS:Li#?

uses the #? pattern to match with the Libs: directory.
CHANGETASKPRI


Format:            CHANGETASKPRI <priority>PROCESS [<process number>]
Template:            PRI=PRIORITY/A/N, PROCESS/K/N
Purpose:To change the priority of a currently running
process.
Path:            C:CHANGETASKPRI
Specification:

Since the Amiga is multitasking, it uses priority numbers to determine
the order in which current tasks should be serviced. Normally, most
tasks have a priority of 0, and the time and instruction cycles of the
CPU are divided equally among them. CHANGETASKPRI changes the priority
of the specified Shell process. (lf no process is specified, the
current Shell process is assumed.) Any tasks started from <process
number> inherit its priority.

Use the STATUS command to display the current process numbers.

The range of acceptable values for <priority> is the integers from -128
to 127, with higher values yielding a higher priority (a greater
proportion of CPU time is allocated). However, do not enter values
above +10, or you may disrupt important system tasks. Too low a
priority (less than 0) can result in a process taking unreasonably long
to execute.


Example:

    1> CHANGETASKPRI 4 Process 2

The priority of Process 2 is changed to 4. Any tasks started from this
Shell will also have a priority of 4. They will have priority over any
other user tasks created without using CHANGETASKPRI (those tasks will
have a priority of 0).


See also: STATUS
CLICKTOFRONT


Format:CLICKTOFRONT [CX_PRIORITY <priority>] [QUALIFIER
<qualifer>]
Template:CX_PRIORlTY/N/K, QUALlFlER/K
Purpose:            To bring a window to the front of the screen.
Path:            Extras:Tools/Commodities/C1ickToFront
Specification:

CLICKTOFRONT allows you to bring a window to the front of the
screen by double-clicking in it. You do not need to select the
window's depth gadget.

The CX_PRIORITY <priority> argument sets the priority of ClickToFront
in relation to all the other Commodity Exchange programs. (This is the
same as entering a CX_PRIORITY=<priority> Tool Type in the icon's
Information window.) All the Commodity Exchange programs are set to a
default priority of 0. If you specify a <priority> value higher than 0,
ClickToFront will take priority over any other Commodity Exchange
program.

To start ClickToFront, double-click on its icon. It does not open a
window. (Remember, you can also put ClickToFront in the WBStartup
drawer so that it is automatically started each time you boot.)

QUALIFIER allows you to specify a qualifier key that must be
pressed while double-clicking in the window you want to bring to
the front ofthe screen. The acceptable key arguments are:

    Lalt            Left Alt
    Left_Alt        Left Alt
    Ralt            Right Alt
    Right_Alt        Right Alt
    Ctrl            Ctrl
    Control        Ctrl
    None            No key

To exit ClickToFront when it has been started from the Shell, press
Ctrl+C, or use the BREAK command.
CLOCK


Format:CLOCK [DlGlTAL] [<LEFT>] [<TOP>] [<WlDTH>]
[<HElGHT>] [24HOUR] [SECONDS] [DATE] [<FORMAT>)
[PUBSCREEN <public screen name>)
Template:DIGITAL/S, LEFT/N, TOP/N, WlDTH/N, HElGHT/N,
24HOURJ5, 5ECOND5/5, DATE/5, FORMAT/N, PUBSCREEN/K
Purpose:            To provide an on-screen clock.
Path:            SYS:Utilities/Clock
Specification:

CLOCK allows you to display an on-screen clock. The DIGITAL
option opens a digital clock.

The LEFT, TOP, WIDTH, and HEIGHT options allow you to specify the size
and position of the clock. The keywords are optional; however, the
clock understands numerical arguments by their position, as outlined
below:

1st numberThe clock will open <n> pixels from the left edge of the
screen.
2nd numberThe clock will open <n> pixels from the top of the
screen.
3rd number    The clock will be <n> pixels wide.
4th number    The clock will be <n> pixels high.

For example, if you only wanted to specify the width and height of the
Clock, you would have to use the WIDTH and HEIGHT keywords. If you only
entered two numbers, the clock would interpret them as the LEFT and TOP
positions.

WIDTH and HEIGHT are not available if you use the DIGITAL option. You
cannot change the size of the digital clock, although you can specify
its position.

If the SECONDS option is specified, the seconds are displayed.

If the DATE option is specified, the date is displayed.


Example 1 :
To open a clock that is 75 pixels from the left edge of the screen, 75
pixels from the top edge of the screen, 300 pixels wide and 100 pixels
high, enter:

    1> CLOCK 75 75 300 100

Example 2:
To use the SECONDS, DATE and 24HOUR options, enter:

    1> CLOCK SECONDS DATE 24HOUR

Example 3:
To open a digital clock that is 320 pixels from the left edge of the
screen and in the screen's title bar (0 pixels from the top), enter:

    1> CLOCK DIGITAL 320 0
CMD


Format:            CMD <devicename> <filename> [OPT s|m|n]
Template:            DEVlCENAME/A, FlLENAME/A, OPT/K
Purpose:            To redirect printer output to a file.
Path:            Extras:Tools/CMD
Specification:

The <devicename> can be serial, parallel or printer, and should be the
same device as specified in the Printer editor. <Filename> is the name
of the file to which the redirected output should be sent. The CMD
options are as follows:

sSkip any short initial write (usuall a reset if redirecting a
screen dump).
mIntercept multiple files until a BREAK command or Ctrl+C is
entered.
n    Notify user of progress (messages are displayed on screen).


Example:


    1> CMD parallel RAM:cmd_file

Any output sent to the parallel port will be rerouted to a file in
RAM: called cmd_file.
COLORS


Format:            COLORS [<bitplanes> <screentype>]
Template:            BITPLANES, SCREENTYPE
Purpose:            To change the colors of the frontmost screen.
Path:            Extras:Tools/Colors
Specification:

COLORS lets you change the colors of the frontmost screen. By
specifying values for the <bitplanes> and <screentype> options, you can
open a custom test screen. The acceptable values for <bitplanes> and
<screentype> are listed below:


       <bitplanes>                      <screentype>
 (Specifies the depth of the        (Specifies the resolution of
 test screen:)                        the test screen:)

    1    2 colors                0    320 x 200 pixels
    2    4 colors                1    320 x 400 pixels
    3    8 colors                2    640 x 200 pixels
    4    16 colors                3    640 x 400 pixels
    5    32 colors

The value for <bitplanes> is restricted to 4 or less if the value for
<screentype> is equal to either 2 or 3.


Example:

    1> COLORS 3 2

A new custom screen will be opened, and it will display a window for
the color program. The screen will have 8 colors and a 640 x 200 pixel
(High Res) resolution.
CONCLIP


Format:            CONCLIP [UNlT <unit number>] [OFF]
Template:            UNlT/N, OFF/S
Purpose:To move data between the console.device, the
clipboard.device and CON:
Path:            C:CONCLlP
Specification:

CONCLIP is called from the standard Startup-sequence. When it is run,
the user can copy text from standard Shell windows by drag selecting
text with the mouse. Once text is highlighted, it can then be copied to
the clipboard by pressing right Amiga+C. In addition, some other
console.device windows may support the ability to drag select text,
such as ED and MEmacs. The copied text can then be pasted into any
application window which supports reading text from the clipboard, such
as the Shell, ED, and MEmacs. To paste text, press right Amiga+V.

CONCLIP requires iffparse.library and the clipboard.device and opens
the first time you copy or paste text. Because of this, users with
floppy-based systems may notice some delay as iffparse.library and the
clipboard.device are loaded from disk (assuming that they have not
already been loaded by some other application).

The UNIT option allows you to specify the clipboard.device unit number
to use. You can specify any unit from 0 to 255. The default number is
0. This option is primarily for advanced users or programmers who may
want to use different units for different data, such as one for text
and another for graphics. You do not need to turn CONCLIP off to change
the UNIT number. Simply run the command from the Shell, specifying the
new unit number. The next time you copy and paste, that clipboard unit
will be used.

The OFF option allows the more advanced user or programmer to turn off
CONCLIP. When turned off, text is not copied to the clipboard, and
pasting is transparently managed by the console.device. In general,
there is no reason to turn CONCLIP off.
COPY


Format:COPY [FROM] {<name|pattern>} [TO] <name|pattern>
[ALL] [QUIET] [BUF|BUFFER=<n>] [CLONE] [DATES]
[NOPRO] [COM] [NOREQ]
Template:FROM/M, TO/A, ALL/S, QUlET/S, BUF=BUFFER/K/N,
CLONE/S, DATES/S, NOPRO/S, COM/S, NOREQ/S
Purpose:            To copy files or directories.
Path:            C:COPY
Specification:

COPY copies the file or directory specified with the FROM argument to
the file or directory specifed by the TO argument. You can copy several
items at once by giving more than one FROM argument; each argument
should be separated by spaces. You can use pattern matching to copy or
exclude items whose names share a common set of characters or symbols.

If a TO filename already exists, COPY overwrites the TO file with the
FROM file. If you name a destination directory that does not exist,
COPY will create a directory with that name. You can also use a pair of
double quotes ("") to refer to the current directory when specifying a
destination. Do not put any spaces between the double quotes.

If the FROM argument is a directory, only the directory's files will be
copied; its subdirectories will not be copied. Use the ALL option to
copy the complete directory, including its files, subdirectories, and
the subdirectories' files. If you want to copy a directory and you want
the copy to have the same name as the original, you must include the
directory name in the TO argument.

COPY prints to the screen the name of each file as it is copied. This
can be overridden by the QUIET option.

The BUF= option is used to set the number of 512-byte buffers used
during the copy. (Default is 200 buffers, approximately 100KB of RAM.)
It is often useful to limit the number of buffers when copying to RAM:.
BUF=0 uses a buffer the same size as the file to be copied.

Normally, COPY gives the TO file the date and time the copy was made,
rather than the date and time the file was created or last revised. Any
comments attached to the original FROM file are ignored. The protection
bits of the FROM file are copied to the TO file. Several options allow
you to override these defaults:

DATESThe creation or last revised date (whichever is most recent)
of the FROM file is copied to the TO file.
COMAny comment attached to the FROM file is copied to the TO
file.
NOPROThe protection bits of the FROM file are not copied to the TO
file. The TO file will be given standard protection bits of
r, w, e and d.
CLONEThe creation (or last revised) date, comments and protection
bits of the FROM file are copied to the TO file.
Normally, COPY displays a requester if the COPY cannot continue for
some reason. When the NOREQ option is given, all requesters are
suppressed. This is useful in scripts and can prevent a COPY failure
from stopping the script while it waits for a response. For example, if
a script calls for a certain file to be copied and the system cannot
find that file, normally the script would display a requester and would
wait until a response was given. With the NOREQ option, the COPY
command would be aborted and the script would continue.


Example 1:

    1> COPY File1 TO :Work/File2

copies File1 in the current directory to the File2 directory in the
Work directory.


Example 2 :

    1> COPY ~(#?.info) TO DF1:Backup

copies all the files not ending in .info in the current directory to
the Backup directory on the disk in DF1:. This is a convenient use of
pattern matching to save storage space when icons are not necessary.


Example 3:

    1> COPY Work:Test TO ""

copies the files in the Test directory on Work to the current
directory; subdirectories in Test will not be copied.


Example 4:

    1> COPY Work:Test TO DF0:Test ALL

copies all the files and any subdirectories of the Test directory on
Work to the Test directory on DF0:. If a Test directory does not
already exist on DF0:, AmigaDOS will create one.


Example 5 :

    1> COPY DF0: TO DF1: ALL QUIET

copies all files and directories on the disk in DF0: to DF1:, without
displaying on the screen any file/directory names as they are copied.
(This is quite slow in comparison to DiskCopy.)
CPU


Format:CPU [CACHE] [N0CACHE] [BURST] [NOBURST] [DATACACHE]
[DATABURST] [NODATACACHE] [NODATABURST] [INSTCACHE]
[INSTBURST] [NOINSTCACHE] [NOINSTBURST) [FASTROM]
[NOFASTROM] [NOMMUTEST] [CHECK
68010|68020|68030|68040|68881|68882|68851|MMU|FPU]
[TRAP] [NOTRAP] [COPYBACK] [NOCOPYBACK]
[EXTERNALCACHE] [NOEXTERNALCACHE]
Template:CACHE/S, BURST/S, NOCACHE/S, NOBURST/S,
DATACACHE/S, DATABURST/S, NODATACACHE/S,
NODATABURST/S, INSTCACHE/S, INSTBUftST/S,
NOINSTCACHE/S, NOINSTBURST/S, COPYBACWS,
NOCOPYBACK/S, EXTERNALCACHE/S, NOEXTERNALCACHE/S,
FASTROM/S, NOFASTROM,S, TRAP/S, NOTRAP/S,
NOMMUTEST/S, CHECK/K
Purpose:To set or clear the CPU caches, check for a
particular processor, load the ROM image into fast,
32-bit memory, or set an illegal memory access
handler which will output information over the
serial port at 9600 baud if a task accesses page
zero (lower 256 bytes) or memory above 16M on a
68000 Amiga.
Path:            C:CPU
Specification:

CPU allows you to adjust various options of the microprocessor
installed in your Amiga. CPU will also show the processor and options
that are currently enabled.

Many options only work with certain members of the 680X0 processor
family. The 68020 has a special type of memory known as instruction
cache. When instruction cache is used, instructions are executed more
quickly. The 68030 has two types of cache memory: instruction and data.
The CPU options, outlined below, specify the types of memory to be
used. If mutually exclusive options are specified, the safest option is
used.

Availability of the options listed below depends on availability of
required hardware.

CACHE        Turns on all caches.
NOCACHE        Turns off all caches.
BURST        Turns on burst mode for both data and instructions.
NOBURST        Turns off burst mode for data and instructions.
DATACACHE        Turns on data cache.
NODATACACHE    Turns off data cache.
DATABURST        Turns on burst mode for data.
NODATABURST    Turns off burst mode for data.
INSTCACHE        Turns on instruction cache.
INSTBURST        Turns on burst mode for instruction.
NOINSTCACHE    Turns off instruction cache.
NOINSTBURST    Turns off burst mode for instructions.
FASTROMIf supported by the MMU, copies data from ROM into
32-bit RAM, making access to this data significantly
faster. CPU then writeprotects the RAM area so that the
data cannot be changed.
NOFASTROM        Turns off FASTROM.
NOMMUTESTAllows the MMU settings to be changed without checking
to see if MMU is currently in use.
TRAP            Developer-specific.
NOTRAP        Developer-specific.
COPYBACK        Turns on cache copyback.
NOCOPYBACK    Turns off cache copyback.
EXTERNALCACHE    Turns on external cache.
NOEXTERNALCACHE Turns off external cache.


The CHECK option, when given with a keyword (68010, 68020, 68030,
68040, 68881, 68882, or 68851, MMU, FPU) checks for the presence of the
keyword.


Examples:

    1>  CPU
    System: 68030 68881 (INST: Cache Burst) (DATA: Cache NoBurst)

    1> CPU NoDataCache FastROM
    System: 68030 68881 FastROM (INST: Cache Burst) DATA: NoCache
    NoBurst)

    1> CPU NoBurst DataCache NoInstCache
    System: 68030 68881 (INST: NoCache NoBurst) (DATA: Cache NoBurst )
CROSSDOS


Format:CROSSDOS [CX_PRIORITY <priority>] [CX_POPKEY <key>]
[CX_POPUP <yes|no>]
Template:   CX_PRIORITY/N/K, CX_POPKEY/K, CX_POPUP/K
Purpose:    To set text filter and conversion options.
Path:       Extras: Tools/Commodities/CrossDOS
Specification:

CROSSDOS lets you read from and write to MS-DOS formatted disks using
your standard Amiga drives. This makes it simple to transfer
information such as text, font, database, and graphics files between
Amiga and MS-DOS computers. Use the CROSSDOS command to set text filter
and conversion options during this transfer.

The Standard DOS drivers for CrossDOS are PC0: and PC1:, which
correspond to DF0: and DF1:. These two drivers allow an Amiga floppy
drive to read from and write to 720KB MS-DOS disks. CrossDOS drivers
still handle your Amiga disks normally.

CX_POPKEY allows you to specify the hot key for the program. If more
than one key is specified, be sure to enclose the entire argument in
double-quotes (i.e., CX_POPKEY="Shift F1").

CX_POPUP=no will prevent the CrossDOS window from opening. By default
the program window opens when the command is invoked.

CX_PRIORITY sets the priority of CrossDOS in relation to all other
Commodity Exchange programs. All the Commodity Exchange programs are
set to a default priority of 0.

For complete information on CrossDOS, see Using the Amiga Worhbench
manual.
DATE


Format:            DATE [<day>] [<date>] [<time>] [TO|VER<filename>]
Template:            DAY, DATE, TIME,TO=VER/K
Purpose:            To display or set the system date and/or time.
Path:            C:DATE
Specification:

DATE with no argument displays the currently set system time and date,
including the day of the week. Time is displayed using a 24-hour clock.

DATE <date> sets just the date. The format for <date> is DD-MMM-W
(day-month-year). The hyphens between the arguments are required. A
leading zero in the date is not necessary. The number or the first 3
letters of the month (in English) must be used, as well as the last two
digits of the year.

If the date is already set, you can reset it by specifying a day name
(this sets the date forward to that day of the week). You cannot
specify a day name to change the date to more than seven days into the
future. You can also use tomorrow or yesterday as the <day> argument.

DATE <time> sets the time. The format for <time> is HH:MM:SS
(hours:minutes:seconds). Seconds are optional.

If your Amiga does not have a battery backed-up hardware clock and you
do not set the date, the system, upon booting, will set the date to the
date of the most recently created file on the boot disk.

If you specify the TO or VER option, followed by a filename, the output
of the DATE command will be sent to that file, overwriting any existing
contents.

Adjustments made with DATE only change the software clock. They will
not survive past power-down. To set the battery back-up hardware clock
from the Shell, you must set the date then use SETCLOCK SAVE.


Example 1:

    1> DATE

displays the current date and time.


Example 2:

    1> DATE 6-sep-82

sets the date to September 6, 1982. The time is not reset.


Example 3:

    1> DATE tomorrow

resets the date to one day ahead.
Example 4:

    1> DATE TO Fred

sends the current date to the file Fred.


Example 5:

    1> DATE 23:00

sets the current time to 11:00 p.m.


Example 6:

    1> DATE 1-jan-02

sets the date to January lst, 2002. The earliest date you can set is
January 1, 1978.
DELETE


Format:            DELETE {<name|pattern>} [ALL] [QUIET] [FORCE]
Template:            FlLE/M/A, ALLL/S, QUlET/S, FORCE/S
Purpose:            To delete files or directories.
Path:            C:DELETE
Specification:

DELETE attempts to delete (erase) the specified files. If more than one
file was specified, AmigaDOS continues to the next file in the list.

You can use pattern matching to delete files. The pattern may specify
directory levels as well as filenames. All files that match the pattern
are deleted. To abort a multiple-file DELETE, press Ctrl+C.

CautionAmigaDOS does not request confirmation of deletions. An error
in a pattern-matching DELETE can have severe consequences, as
deleted files are unrecoverable. Be sure you understand
pattern matching before you use this feature, and keep
backups of important files.

If you try to delete a directory that contains files, you will receive
a message stating that the directory could not be deleted as it is not
empty. To override this, use the ALL option. DELETE ALL deletes the
named directory, its subdirectories, and all files.

Filenames are displayed on the screen as they are deleted. To suppress
the screen output, use the QUIET option.

If the d (deletable) protection bit ofa file has been cleared, that
file cannot be deleted unless the FORCE option is used.


Example 1:

    1> DELETE Old-file

deletes the file named Old-file in the current directory.


Example 2:

    1> DELETE Work/Prog1 Work/Prog2 Work

deletes the files Prog1 and Prog2 in the Work directory, and then
deletes the Work directory (if there are no other files left in it).


Example 3:

    1> DELETE T#?/#?(1|2)

deletes all the files that end in 1 or 2 in directories that start with
T.
Example 4:

    1> DELETE DF1:#? ALL FORCE

deletes all the files on DF1:, even those set as not deletable.
See also: PROTECT
DIR


Format:DIR [<dir|pattern>] [OPT A|I|AI|D|F] [ALL] [DIRS]
[FILES] [INTER]
Template:            DIR, OPT/K, ALL/S, DIRS/S, FILES/S, INTER/S
Purpose:To display a sorted list ofthe files in a
directory.
Path:            C:DIR
Specification:

DIR displays the file and directory names contained in the specified
directory or the current directory. If no name is given, directories
are listed first, followed by an alphabetical list of the files in two
columns. Pressing Ctrl+C aborts a directory listing.

The options are:
ALL        Displays all subdirectories and their files.
DIRS        Displays only directories.
FILES    Displays only files.
INTER    Enters an interactive listing mode.

The ALL, DIRS, FILES and INTER keywords supersede the OPT A, D, F and I
options, respectively. The older keywords are retained for
compatibility with earlier versions of AmigaDOS. Do not use OPT with
the full keywords - ALL, DIRS, FILES, or INTER.

The interactive listing mode stops after each name and displays a
question mark at which you can enter commands. The acceptable responses
are shown below:

Return        Displays the next name on the list.
E        Enters a directory; the files in that directory will be
displayed.
B            Goes back one directory level.
DEL or DELETEDeletes a file or empty directory. DEL does not refer to
the Del key; enter the letters D, E, and L.
T            Types the contents of a file.
C or COMMAND    Allows you to enter additional AmigaDOS commands.
Q            Quits interactive editing.
?        Displays a list of the available interactive-mod
commands.

The COMMAND option allows almost any AmigaDOS command to be executed
during the interactive directory list. When you want to issue a
command, enter C (or COMMAND) at the question mark prompt. DIR will ask
you for the command. Enter the desired command, then press Return. The
command will be executed and DIR will continue. You can also combine
the C and the command on one line, by putting the command in quotes
following the C.


For example,

    1>? C "type prefs.info hex"

is equivalent to pressing Q to exit interactive listing mode and return
to a regular Shell prompt, and entering:
1> TYPE Prefs.info HEX

The Prefs.info file would be typed to the screen in hexadecimal format.

It is dangerous to format a disk from the DIR interactive mode, as the
format will take place immediately, without any confirmation requesters
appearing. Also, starting another interactive DIR from interactive mode
will result in garbled output.


Example 1:

    1> DIR Workbench:

displays a list of the directories and files on the Workbench disk.


Example 2:

    1> DIR MyDisk:#?.memo

displays all the directories and files on MyDisk that end in .memo.


Example 3:

    1> DIR Extras: ALL

displays the complete contents of the Extras disk-all directories, all
subdirectories and all files, including those in the subdirectories.


Example 4:

    1> DIR Workbench: DIRS

displays only the directories on Workbench.


Example 5:

    1> DIR Workbench: INTER

provides an interactive list ofthe contents of the Workhench disk.
DISKCHANGE


Format:            DISKCHANGE <device>
Template:            DRlVE/A
Purpose:        To inform the Amiga that you have changed a disk in
a disk drive.
Path:            C:DlSKCHANGE
Specification:

The DISKCHANGE command is only necessary when you are using 5.25 inch
floppy disk drives or removable media drives without automatic
diskchange hardware. Whenever you change the disk or cartridge of such
a drive, you must use DISKCHANGE to inform the system of the switch.

Example:

If a requester appears and asks you to insert a new disk into your 5.25
inch drive, known as DF2:, you must insert the disk, then enter:

    1> DISKCHANGE DF2:

AmigaDOS will then recognize the new disk, and you can proceed.
DISKCOPY


Format:        DISKCOPY [FROM] <device> TO <device> [NAME <name>]
[NOVERIFY] [MULTI]
Template:            FROM/A, TO/A, NAME/K, NOVERIFY/S, MULTI/S,
Purpose:            To copy the contents of one disk to another.
Path:            SYS:System/DiskCopy
Specification:

The DISKCOPY command copies the entire contents of one volume to
another.

The <device> parameters specify the name of the disk devices to copy
from and to copy to, for example, DF0: or DF1:.

A floppy disk containing an altered icon can be displayed from the
Workbench by removing the disk from the drive and reinserting it.

By default, the destination disk will have the same name as the source
disk. If you specify the NAME option, you can give the destination disk
a different name from the source disk.

Normally during a DISKCOPY, the Amiga copies and verifies each cylinder
of data. The NOVERIFY option allows you to skip the verification
process, making the copy faster.

The MULTI option loads the data on the source disk into memory,
allowing you to make multiple copies without having to read the data
from the source disk each time.


Example 1:

    1> DISKCOPY DF0: to DF2:

copies the contents of the disk in drive DF0: to the disk in drive DF2:
overwriting the contents of the disk in drive DF2:


Example 2:

    1> DISKCOPY DF0: to DF2: NAME NewDisk NOVERIFY

copies the contents of the disk in drive DF0: to the disk in drive DF2:
and gives the disk in drive DF2: the name NewDisk. The disk will not be
verified as it is copied.
DISPLAY


Format:        DISPLAY {<filename>|FROM <filelist>} [OPT mlbpaenv
t=<n>]
Template:            FILENAME/A/M, FROM/K, OPT/K, T/N
Purpose:            To display graphics saved in IFF ILBM format.
Path:            SYS:Utilities/Display
Specification:

DISPLAY displays graphics saved using the IFF ILBM format. You can
enter a series of files on the command line, and they will be shown in
the order given. You can also create a script containing a list of all
the IFF files you'd like to display and use the FROM <filelist>
argument.

The options are listed below. Remember, the OPT keyword must be
used.
mClicking the selection button displays the next file in the
filelist; clicking the menu button displays the previous file.
lInstead of exiting after the last picture, DISPLAY will return to
the first file and start again.
bPictures stay on their own unactivated screen behind the Workbench
screen. This is useful when printing pictures while doing
something else.
pPrints each file that is displayed. You can also press Ctrl+P
while the file is on the screen.
aPictures that are larger than the display area will scroll
automatically when the pointer is moved to the edge of the screen.
eThis option tells Display that the picture is in Extra Halfbrite
mode. This is for users who may be using an early HAM paint
package that does not save a CAMG chunk. Normally, if there is no
CAMG, DISPLAY will treat the image as a HAM picture. A CAMG chunk
is part of an IFF file that describes in which viewmode the
picture should be displayed.
n    Borders will not be transparent when genlocked.
vPictures will be displayed with full-video display clip. This
means that the picture will fill the maximum possible position on
the right edge of the screen, going a little beyond the Overscan
settings in Preferences. However, when using this option, the
screen cannot be dragged sideways, and DISPLAY cannot center the
picture.

The t=<n> argument specifies the number of seconds the IFF file will be
displayed. This allows for automatic advancing through files.


Example 1:

    1> DISPLAY file1 file2 file3

displays the fles in the order given. To advance from one file to the
next, press Ctrl+C.
Example 2 :

    1> DISPLAY FROM Scriptlist

displays the files listed in the Scriptlist file. Pressing Ctrl+C wi11
advance to the next file.


Example 3 :

    1> DISPLAY FROM Scriptlist OPT mp

displays the files listed in the Scriptlist file. Clicking the
selection button advances to the next file in the list. Clicking the
menu button displays the previous file. Each file is printed as it is
displayed.


Example 4:

    1> DISPLAY FROM Scriptlist OPT t=5

displays each file in the Scriptlist file for five seconds. DISPLAY is
replaced by MultiView in Workbench 3.0 level software.
ECHO


Format:            ECHO [<string>] [NOLINE] [FlRST <n>] [LEN <n>]
Template:            /M, NOLlNE/S, FlRST/K/N, LEN/K/N, TO/K
Purpose:            To display a string.
Path:            Internal
Specification:

ECHO writes the specified string to the current output window or
device. By default this is the screen, but it could be to any device or
file. When the string contains spaces, the whole string must be
enclosed in double quotes. (ECHO is commonly used in scripts.)

When the NOLINE option is specified, ECHO does not automatically move
the cursor to the next line after printing the string.

The FIRST and LEN options allow the echoing of a substring. FIRST <n>
indicates the character position from which to begin the echo; LEN <n>
indicates the number of characters of the substring to echo, beginning
with the first character. If the FIRST option is omitted and only the
LEN keyword is given, the substring printed will consist of the
rightmost <n> characters of the main string. For example, if your
string is 20 characters long and you specify LEN 4, the 17th, 18th,
19th, and 20th characters of the string will be echoed.


Examples:

    1> ECHO "hello out there!"
    hello out there!

    1>  ECHO  "hello out there!"   NOLINE FIRST 0 LEN 5
    hello1>
ED


Format:        ED [FROM] <filename> [SIZE <n>] [WITH <filename>]
[WINDOW] [TABS <n>] [WIDTH <n>] [HEIGHT <n>]
Template:        FROM/A, SIZE/N, WITH/K, WINDOW/K, TABS/N,
WIDTH=COLS/N, HEIGHT=ROWS/N
Purpose:            To edit text files (a screen editor).
Path:            C:ED
Specification:

See Chapter 6, "Editors."
EDIT


Format:        EDIT [FROM] <filename> [[TO] <filename>] [WITH
<filename>] [VER <fllename>] [[OPT P <lines>|W
<chars>]|[PREVIOUS <lines>|WIDTH <chars>]]
Template:        FROM/A, TO, WITH/K, VER/K, OPT/K, WIDTH/N,
PREVIOUS/N
Purpose:        To edit text files by processing the source file
sequentially (a line editor).
Path:            C:EDlT
Specification:

See Chapter 6, "Editors."
ELSE


Format:            ELSE
Template:            (none)
Purpose:        To specify an alternative for an IF statement in a
script file.
Path:            Internal
Specification:

ELSE is used in an IF block of a script to specify an alternative
action in case the IF condition is not true. If the IF condition is not
true, execution of the script will jump from the IF line to the line
after ELSE; all intervening commands will be skipped. If the IF
condition is true, the commands immediately following the IF statement
are executed up to the ELSE. Then, execution skips to the ENDIF
statement that concludes the IF block.


Example:
Assume a script, called Display, contained the following block:

    IF exists <name>
        TYPE  <name>  NUMBER
    ELSE
        ECHO "<name> is not in this directory"
    ENDIF

To execute this script, you could enter:

    1> EXECUTE Display work/prg2

If the work/prg2 file can be found in the current directory, the TYPE
<name> NUMBER command will be executed. The work/prg2 file will be
displayed on the screen with line numbers.

If the work/prg2 file cannot be found in the current directory, the
script will skip ahead to the ECHO "<name> is not in this directory"
coommand. The message:

    work/prg2 is not in this directory

will be displayed in the Shell window.


See also: IF, ENDIF, EXECUTE
ENDCLI


Format:            ENDCLI
Template:            (none)
Purpose:            To end a Shell process.
Path:            Internal
Specification:

ENDCLI ends a Shell process.


See also: ENDSHELL
ENDIF


Format:            ENDIF
Template:            (none)
Purpose:            To terminate an IF block in a script file.
Path:            Interna1
Specification:

ENDIF is used in scripts at the end of an IF block. If the IF condition
is not true, or if the true-condition commands were executed and an
ELSE has been encountered, the execution of the script will skip to the
next ENDIF command. Every IF statement must be terminated by an ENDIF.

The ENDIF applies to the most recent IF or ELSE command.


See also: IF, ELSE
ENDSHELL


Format:            ENDSHELL
Template:            (none)
Purpose:            To end a Shell process.
Path:            Internal
Specification:

ENDSHELL ends a Shell process.

The Shell process can also be ended by ENDCLI or clicking on the Close
gadget.

ENDSHELL should only be used when the Workbench is loaded or another
Shell is running. If you have quit the Workbench and you close your
only Shell, you will be unable to communicate with the Amiga. Your only
recourse will be to reboot.

The Shell window may not close if any processes that were launched from
the Shell are still running. Even though the window stays open, the
Shell will not accept new input. You must terminate those processes
before the window will close. For example, if you opened an editor from
the Shell, the Shell window will not close until you exit the editor.
ENDSKIP


Format:            ENDSKIP
Template:            (none)
Purpose:            To terminate a SKIP block in a script file.
Path:            Internal
Specification:

ENDSKIP is used in scripts to terminate the execution of a SKIP block.
A SKIP block allows you to jump over intervening commands if a certain
condition is met. When an ENDSKIP is encountered execution of the
script resumes at the line following the ENDSKIP. The condition flag is
set to 5 (WARN).


See also: SKIP
EVAL


Format:        EVAL <value1> {[<operation>] [<value2>]} [TO<file>]
[LFORMAT=<string>]
Template:            VALUE1/A, OP, VALUE2/M, TO/K, LFORMAT/K
Purpose:            To evaluate simple expressions.
Path:            C:EVAL
Specification:

EVAL is used to evaluate and print the answer of an integer expression.
The fractional portion of input values and final results, if any, are
truncated (cut off). Decimals are not allowed, evaluation stops at the
decimal point.

<Value1> and <value2> may be decimal, hexadecimal, or octal numbers.
Decimal numbers are the default. Hexadecimal numbers are indicated by
either a leading 0x or #x. Octal numbers are indicated by either a
leading 0 or a leading #. Alphabetical characters are indicated by a
leading single quote (').

The output format defaults to decimal; however, you can use the LFORMAT
keyword to select another format. The LFORMAT keyword specifies the
formatting string used to print the answer. You may use %X
(hexadecimal), %O (octal), %N (decimal), or %C (character). The %X and
%O options require a number of digits specifcation (i.e., %X8 gives 8
digits of hex output). When using the LFORMAT keyword, you can specify
that a new line should be printed by including a *N in your string.

The supported operations and their corresponding symbols are shown
below:

Operation                Symbol
---------                ------
addition                +
subtraction            -
multiplication            *
division                /
modulo                mod
AND                    &
OR                    |
NOT                    ~
left shift            lsh
right shift            rsh
negation                -
exclusive OR            xor
bitwise equivalence        eqv

EVAL can be used in scripts to act as a counter for loops. In that
case, the TO option, which sends the output of EVAL to a file, is very
useful.

Parentheses may be used in the expressions.

Example 1:

    1> EVAL 64 / 8 + 2
    10
Example 2:


    1> EVAL 0x5f / 010 LFORMAT="The answer is %X4*N"
    The answer is 000B

This divides hexadecimal 5f(95) by octal 10(8), yielding 000B, the
integer portion ofthe decimal answer 11.875. (The 1> prompt would have
appeared immediately after the 000B if *N had not been specified in the
LFORMAT string.)


Example 3 :
Assume you were using the following script, called Loop:

    Key loop/a
    ;demo a loop using eval and skip
    .Bra {
    .Ket }
    ECHO >ENV:Loop {loop}
    LAB start
    ECHO "Loop #" noline
    TYPE  ENV:Loop
    EVAL <ENV:Loop >NlL: to=T:Qwe{$$} value2=1 op=- ?
    TYPE >ENV:Loop T:Qwe{$$}
    IF val $loop GT 0
    SKIP start back
    ENDIF
    DELETE ENV:Loop T:Qwe{$$} ; clean up
    ECHO  "done"

If you were to enter:

    1> EXECUTE Loop 5

the following results would be displayed:


    1> EXECUTE Loop 5
    Loop #5
    Loop #4
    Loop #3
    Loop #2
    Loop #1
    done

The first ECHO command sends the number given as the loop argument,
entered as an argument of the EXECUTE command, to the ENV:Loop file.

The second ECHO command coupled with the TYPE command, displays Loop #
followed by the number given as the loop argument. In this case, it
displays Loop #5.

The EVAL command takes the number in the ENV:Loop file as <value1>,
which makes the question mark at the end of the line necessary.
<Value2> is 1, and the operation is subtraction. The output of the EVAL
command is sent to the T:Qwe{$$} case, the value would be 4.
The next IF command sends the value in the T:Qwe{$$} file to the
ENV:Loop file. In this case, it changes the value in ENV:Loop from 5 to
4.

The IF statement states that as long as the value for Loop is greater
than 0, the script should start over. This results in the next line
being Loop #4.

The script will continue until Loop is equal to 0.
EXCHANGE


Format:        EXCHANGE [CX_POPKEY<key>] [CX_POPUP<yes|no>]
[CX_PRlORlTY <Priority>]
Template:        CX_PRIORITY/N/K, CX_POPKEY/K, CX_POPUP/K
Purpose:        To monitor and control the Commodity Exchange
programs.
Path:            Extras:Tools/Commodities/Exchange
Specification:

EXCHANGE is a Commodity Exchange program that monitors and controls all
the other Commodity Exchange programs. CX_POPKEY allows you to specify
the hot key for the program. If more than one key is specified, be sure
to enclose the entire argument in double-quotes (i.e., CX_POPKEY Shift
F1").

CX_POPUP will keep the Exchange window from opening.

CX_PRIORITY sets the priority of Exchange in relation to all the other
Commodity Exchange programs. All the Commodity Exchange programs are
set to a default priority of 0. To exit EXCHANGE once it has been
started from the Shell, press Ctrl+C or use the BREAK command.


Example:

    1> EXCHANGE CX_POPKEY "Shift F1"

The Exchange program will be started and its window will appear on the
screen. If you Hide the window, then want to bring it back again, the
hot key combination is Shift+F1.
EXECUTE


Format:            EXECUTE <script> [{<arguments>}]
Template:            FILE/A
Purpose:        To execute a script with optional argument
substitution.
Path:            C:EXECUTE
Specification:

EXECUTE is used to run scripts of AmigaDOS commands. The lines in the
script are executed just as if they had been entered at a Shell prompt.
If the s protection bit of a file is set and the file is in the search
path, you only need to enter the filename - the EXECUTE command is not
needed.

You can use parameter substitution in scripts by including special
keywords in the script. When these keywords are used, you can pass
variables to the script by including the variable in the EXECUTE
command line. Before the script is executed, AmigaDOS checks the
parameter names in the script against any arguments given on the
command line. If any match, AmigaDOS substitutes the values you
specified on the command line for the parameter name in the script. You
can also specify default values for AmigaDOS to use if no variables are
given. If you have not specifed a variable, and there is no default
specified in the script, then the value of the parameter is empty (no
substitution is made).

The permissible keywords for parameter substitution are explained
below. Each keyword must be prefaced with a dot character (.).

The .KEY (or .K) keyword specifies both keyword names and positions in
a script. It tells EXECUTE how many parameters to expect and how to
interpret them. In other words, .KEY serves as a template for the
parameter values you specify. Only one .KEY statement is allowed per
script. If present, it should be the first line in the file.

The arguments on the .KEY line can be given with the /A and /K
directives, which work the same as in an AmigaDOS template. Arguments
followed by /A are required; arguments followed by /K require the name
of that argument as a keyword. For example, if a script starts with
.KEY filename/A it indicates that a filename must be given on the
EXECUTE command line after the name of the script. This filename will
be substituted in subsequent lines of the script. For example, if the
first line of a script is:

    .KEY filename/A, TO/K

you must specify a filename variable. The TO variable is optional, but
if specified the TO keyword must be used. For example:

    1> EXECUTE Script Textfile TO NewFile
Before execution, AmigaDOS scans the script for any items enclosed by
BRA and KET characters (< and >). Such items may consist of a keyword
or a keyword and a default value. Wherever EXECUTE finds a keyword
enclosed in angle brackets, it tries to substitute a parameter.
However, if you want to use a string in your script file that contains
angle brackets, you will have to defne substitute "bracket" characters
with the .BRA and .KET commands. .BRA <ch> changes the opening bracket
character to <ch>, while .KET <ch> changes the closing bracket
character to <ch>. For example:

    .KEY filename
    ECHO "This line does NOT print <angle> brackets."
    .BRA {
    .KET }
    ECHO "This line DOES print <angle> brackets."
    ECHO "The specified filename is {filename}.'

would result in the following output:

    1> EXECUTE script TestFile
    This line does NOT print brackets.
    This line DOES print <angle> brackets.
    The specified filename is TestFile.

The first ECHO statement causes AmigaDOS to look for a variable to
substitute for the <angle> parameter. If no argument was given on the
EXECUTE command line, the null string is substituted. The .BRA and .KET
commands then tell the script to use braces to enclose parameters. So,
when the second ECHO statement is executed, the angle brackets will be
printed. The third ECHO statement illustrates that the braces now
function as the bracket characters.

When enclosing a keyword in bracket characters, you can also specify a
default string to be used if a variable is not supplied on the command
line. There are two ways to specify a default. The first way requires
that you specify the default every time you reference a parameter. You
must separate the two strings with a dollar sign ($).

For example, in the following statement:

    ECHO "<word1$defword1> is the default for Word1."

defword1 is the default value specified for word1. It will be printed
if no other variable is given for word1. However, if you want to
specify this default several times in your script, you would have to
use <word1$defword1> each time.

The .DOLLAR <ch> command allows you to change the default character
from $ to <ch>. (You can also use .DOL <ch>.) For example:

    .DOL #
    ECHO "<word1#defword1> is the default for Word1."

The second way to define a default uses the .DEF command. This allows
you to specify a default for each specific keyword. For example:

    .DEF word1 "defword1"
assigns defword1 as the default for the word1 parameter throughout the
script. The following statement:

    ECHO "<word1> is the default for Word1."

results in the same output as the previous ECHO statement:

    defword1 is the default for Word1.

You can embed comments in a script by including them after a semicolon
(;) or by entering a dot (.), followed by a space, then the comment.

.KEY                Argument template used to specify the format
of arguments; may be abbreviated to .K
.DOT <ch>                Change dot character from . to <ch>
.BRA <ch>            Change opening "bracket" character from < to
<ch>
.KET <ch>            Change closing "bracket" character from > to
<ch>
.DOLLAR <ch>        Change default character from $ to <ch>; may
be abbreviated to .DOL
.DEF <keyword> <value>    Give default to parameter
.<space>                Comment line
.\                    Blank comment line

When you EXECUTE a command line, AmigaDOS looks at the first line of
the script. If it starts with a dot command, AmigaDOS scans the script
looking for parameter substitution and builds a temporary file in the
T: directory. If the file does not start with a dot command, AmigaDOS
assumes that no parameter substitution is necessary and starts
executing the file immediately without copying it to T:. Ifyou do not
need parameter substitution, do not use dot commands as they require
extra disk accesses and increase execution time.

AmigaDOS provides a number of commands that are useful in scripts, such
as IF, ELSE, SKIP, LAB, and QUIT. These commands, as well as the
EXECUTE command, can be nested in a script. That is, a script can
contain EXECUTE commands.

To stop the execution of a script, press Ctrl+D. If you have nested
script files, you can stop the set of EXECUTE commands by pressing
Ctrl+C. Ctrl+D only stops the current script from executing.

The current Shell number can be referenced by the characters <$$>. This
is useful in creating unique temporary files, logical assignments, and
PIPE names.


Example 1:
Assume the script List contains the following:

    .K filename
    RUN COPY <filename> TO PRT: +
    ECHO "Printing of <filename> done"
The following command:

    1> EXECUTE List Test/Prg

acts as though you had entered the following commands at the keyboard:

    1> RUN COPY Test/Prg TO PRT: +
    1> ECHO "Printing of Test/Prg done"


Example 2:
Another example, Display, uses more of the features described above:

    .Key name/A
    IF EXISTS <name>
    TYPE <name> NUMBER    ;if file is in the given directory
                    ;type it with line numbers
    ELSE
    ECHO "<name> is not in this directory"
    ENDIF

The command:

    1> RUN EXECUTE Display Work/Prg2

should display the Work/Prg2 file, with line numbers on the screen, if
it exists on the current directory. If the file is not there, the
screen displays an error message. Because of the /A, if a filename is
not given on the command line after Display, an error will occur.


See also: IF, SKIP, FAILAT, LAB, ECHO, RUN, QUIT
FAILAT


Format:            FAILAT [<n>]
Template:            RCLIM/N
Purpose:        To instruct a command sequence to fail if a program
gives a return code greater than or equal to the
given value.
Path:            Internal
Specification:

Commands indicate that they have failed in some way by setting a return
code. A nonzero return code indicates that the command has encountered
an error of some sort. The return code, normally 5, 10, or 20,
indicates how serious the error was. A return code greater than or
equal to a certain limit, the fail limit, terminates a sequence of
non-interactive commands (commands you specify after RUN or in a
script).

You may use the FAILAT command to alter the fail limit RCLIM (Return
Code Limit) from its initial value of 10. If you increase the limit,
you indicate that certain classes of error should not be regarded as
fatal and that execution of subsequent commands may proceed after an
error. The argument must be a positive number. The fail limit is reset
to the initial value of 10 on exit from the command sequence.

If the argument is omitted, the current fail limit is displayed.

Example:
Assume a script contains the following lines:

    COPY DF0:MyFile to RAM:
    ECHO "MyFile being copied."

If MyFile cannot be found, the script will be aborted and the following
message will appear in the Shell window:

    COPY: object not found
    COPY failed returncode 20:

However, if you changed the return code limit to higher than 20, the
script would continue even if the COPY command fails. For example, if
you changed the script to read:

    FAILAT 21
    COPY DF0:MyFile to RAM:
    ECHO "MyFile being copied."

even if MyFile cannot be found, the script will continue. The following
message will appear in the Shell window:

    COPY: object not found
    MyFile being copied.


See also: ECHO, EXECUTE
FAULT


Format:            FAULT {error number}
Template:            /N/M
Purpose:        To print the messages(s) for the specified error
code(s).
Path:            Internal
Specification:

FAULT prints the messages corresponding to the error numbers supplied.
Any number of error numbers can be specified at once. If several error
numbers are given with FAULT, they must be separated by spaces.

Example:
If you received the error message:

    Error when opening DF1:TestFile 205

and needed more information, you would enter:

    1> FAULT 205
    FAULT 205: object not found

This tells you that the error occurred because TestFile could not be
found on DF1:.

A complete list of error messages appears in Appendix A.
FILENOTE


Format:        FILENOTE [FlLE] <file|pattern> [COMMENT <comment>]
[ALL] [QUlET]
Template:            FlLE/A,COMMENT,ALL/S,QUlET/S
Purpose:            To attach a comment to a file.
Path:            C:FlLENOTE
Specification:

FILENOTE attaches an optional comment of up to 79 characters to the
specified file or to all files matching the given pattern. If the
<comment> includes spaces, it must be enclosed in double quotes. To
include double quotes in a filenote, each literal quote mark must be
immediately preceded by an asterisk (*), and the entire comment must be
enclosed in quotes, regardless of whether the comment contains any
spaces.

If the <comment> argument is omitted, any existing filenote will be
deleted from the named file.

Creating a comment with FILENOTE is the same as entering a comment into
the Comment gadget of an icon's Information window. Changes made with
FILENOTE will be reflected in the Information window, and vice versa.

When an existing file is copied to (specified as the TO argument of a
COPY command), it will be overwritten, but its original comment will be
retained. Any comment attached to a FROM file will not be copied unless
the CLONE or COM option of COPY is specified.

If the ALL option is given, FILENOTE will add the <comment> to all the
files in the specified directory. If the QUIET option is given, screen
output is suppressed.

Example 1:

    1> FILENOTE Sonata "allegro non troppo"

attaches the filenote "allegro non troppo" to the Sonata file.

Example 2 :

    1> FILENOTE Toccata "*"presto*""

attaches the filenote ""presto"" to the Toccata file.
FIXFONTS


Format:            FIXFONTS
Template:            (none)
Purpose:            To update the .font files of the FONTS: directory.
Path:            SYS:System/FixFonts
Specification:

FIXFONTS runs the FixFonts program. FIXFONTS does not support any
arguments. Your disk light will come on while the FONTS: directory is
updated. When the update is finished, the light will go out and a Shell
prompt will appear.

FIXFONTS should be used whenever you make changes in the FONTS:
directory, for example, copying new font files or deleting single font
sizes.

Example:

    1> FIXFONTS
FKEY


Format:        FKEY [CX_PRIORITY <priority>) [CX_POPKEY <key>]
[CX_POPUP <yes|no>]
Template:            CX_PRIORITY/N/K, CX_POPKEY/K, CX_POPUP/K,
Purpose:        To assign text to function and shifted function
keys.
Path:            Extras:Tools/Commodities/FKey
Specification:

FKEY allows you to assign functions to keys, eliminating the need for
repetitive typing.

FKEY lets you assign any of eight commands to any key sequence that you
can enter. The Defined Keys scrolling list shows all the currently
defined key sequences. The New Key and Delete Key gadgets let you add
and remove key sequences.

The Command cycle gadget lets you pick a command for the current key
sequence. The possible commands are the following:

Cycle Windows    Brings the rearmost application window on the
Workbench screen to the front of the display and
activates it. This only affects application windows
opened by tools or projects, such as Clock. Disk
and drawer windows are not affected.
Cycle Screens    Brings the rearmost screen to the front of the
display.
Enlarge Window    Enlarges the active window to its maximum size,
taking into account the edges of the screen.
Shrink Window        Shrinks the active window to its minimum size.
Toggle Window SizeZooms the active window just as if you had selected
the window's zoom gadget. It also works on windows
that only have a zoom gadget and no sizing gadgets.
Insert Text    When the key sequence is entered, the specified
string is inserted instead. The string to insert is
specified in the Command Parameters gadget.
Run Program    Lets you run a program by pressing any key
sequence. The program name and its arguments are
specified in the Command Parameters gadget.
Run ARexx ScriptLets you run an ARexx script by pressing any key
sequence. A script name and its arguments are
specified in the Command Parameters gadget. Putting
quotes around the script name turns it into an
ARexx script.
FONT


Format:        FONT [FROM <flename>] [EDlT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDlT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:            To specify the fonts used by the system.
Path:            Extras:Prefs/Font
Specifications:

FONT with no arguments or with the EDIT argument opens the Font editor.
The FROM argument lets you specify a file to open. This must be a file
that was previously saved with the Save As menu item of the Font
editor. For example, if you have saved a special configuration of the
Font editor to a file in the Presets drawer, you can use the FROM
argument to open that file. If the USE switch is also given, the editor
will not open, but the settings in the FROM file will be used. If the
SAVE switch is given, the editor will not open, but the settings in the
FROM file will be saved.
FORMAT


Format:        FORMAT DEVICE|DRlVE <device> NAME <name>
[<OFS/FFS>] [<INTERNATIONAL|NOINTERNATIONAL>]
[NOICONS] [QUICK]
Template:        DEVICE=DRlVE/K/A, NAME/K/A, OFS/S|FFS/S,
INTL=INTERNATIONAL/S, NOINTL=NOINTERNATIONAL/S,
NOICON/S, QUlCK/S
Purpose:            To format a disk for use with the Amiga.
Path:            SYS:System/Format
Specification:

To format a disk, you must specify both the DEVICE and the NAME
keywords. The name can be from one to thirty-one characters in length.
If you include spaces in the name, it must be enclosed in double
quotes.

The NOICONS option prevents a Trashcan icon from being added to the
newly formatted disk.

The QUICK option specifies that FORMAT will only format and create the
root block (and track), the boot block (and track), and create the
bitmap blocks. This is useful when reformatting a previously formatted
floppy disk.

The OFS option forces the disk to be formatted using the Old File
System. This is the default for floppy disks. The FFS option causes the
disk to be formatted using the Fast File System. This can provide for
faster operation than OFS disks, but the resulting disks cannot be
shared with Amigas with system software releases prior to 2.0. The
INTERNATIONAL option forces the disk to be formatted using the
international versions of the file systems. These international
versions deal correctly with upper and lower letter case conversions of
international characters in filenames. The NOINTERNATIONAL option
forces the non-international equivalent to OFS NOINTERNATIONAL for a
floppy device, and FFS NOINTERNATIONAL for a credit card device.

Example 1:

    1> FORMAT DRIVE DF0: NAME EmptyDisk

formats the disk in drive DF0:, erases any data, and names the disk
EmptyDisk.

Example 2:

    1> FORMAT DRIVE DF2: NAME NewDisk QUICK

Reformats, or erases, a disk that already contains data.
FOUNTAIN


Format:            FOUNTAIN [VALIDATE]
Template:            VALIDATE/S
Purpose:            To manage use of Intellifont outline fonts.
Path:            SYS: System/Fountain
Specification:

FOUNTAIN, which is in the System drawer on the Workbench disk, manages
Intellifont outline fonts on your Amiga. With FOUNTAIN, you can install
new outline fonts on your system, specify new sizes for existing fonts,
and delete fonts that are no longer needed. You can create bitmap
versions of any size outline font that can be used in applications that
do not support outline fonts directly.

FOUNTAIN is valid on Workbench 2.1 level software.
GET


Format:            GET <name>
Template:            NAME/A
Purpose:            To get the value of a local variable.
Path:            Internal
Specification:

GET is used to retrieve and display the value of a local environment
variable. The value is displayed in the current window.

Local environment variables are only recognized by the Shell in which
they are created, or by any Shells created from a NEWSHELL command
executed in the original Shell. If you open an additional Shell by
opening the Shell icon or by using the Execute Command menu item,
previously created local environment variables will not be available.


Example:

    1> GET editor

Extras:Tools/MEmacs

See also: SET
GETENV


Format:            GETENV <name>
Template:            NAME/A
Purpose:            To get the value of a global variable.
Path:            Internal
Specification:

GETENV is used to retrieve and display the value of a global
environment variable. The value is displayed in the current window.
Global variables are stored in ENV: and are recognized by all Shells.

Example:

    1> GETENV editor
    Extras:Tools/MEmacs


See also: SETENV
GRAPHICDUMP


Format:        GRAPHICDUMP [TINY|SMALL|MEDIUM|LARGE|<xdots>:
<ydots>]
Template:        TINY/S, SMALL/S, MEDIUM/S, LARGE/S,
<xdots>:<ydots>/s
Purpose:            To print the frontmost screen.
Path:            Extras:Tools/GraphicDump
Specification:

GRAPHICDUMP sends a dump of the frontmost screen to the printer about
ten seconds after issuing the command. The ten second delay allows the
user to bring the wanted screen to the front. The size options, which
correspond to the program's acceptable Tool Types, determine the width
of the printout:

TINY        1/4 the total width allowed by the printer
SMALL    1/2 the total width allowed by the printer
MEDIUM    3/4 the total width allowed by the printer
LARGE    the full width allowed by the printer

The height of the printout is such that the proportions of the screen
are maintained.

To specify exact dimensions, substitute the absolute width in dots for
<xdots> and the absolute height for <ydots>.


Example 1:

    1> GRAPHICDUMP SMALL

will produce a printout of the frontmost screen that is about one-half
the total width allowed by the printer.


Example 2:

    1> GRAPHICDUMP 600:300

will produce a printout that is 600 dots wide by 300 dots high.
ICONEDIT


Format:            ICONEDIT
Template:            (none)
Purpose:            To edit the appearance and type of icons.
Path:            Extras:Tools/IconEdit
Specifications:

ICONEDIT opens the IconEdit program. The command does not support any
arguments.


Example:

    1> ICONEDIT
ICONTROL


Format:        ICONTROL [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:            To specify parameters used by the Workbench.
Path:            Extras:Prefs/IControl
Specification:

ICONTROL without any arguments or with the EDIT argument opens the
IControl editor. The FROM argument lets you specify a file to open.
This must be a file that was previously saved with the Save As menu
item of the IControl editor. For example, if you have saved a special
configuration of the IControl editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not open, but the settings in the FROM file
will be used. If the SAVE switch is given, the editor will not open,
but the settings in the FROM file will be saved.


Example:

    1> ICONITROL Prefs/Presets/IControl.pre USE

uses the settings that were saved in the IControl.pre file. The editor
is not opened.
ICONX


Format:            ICONX
Template:            (none)
Purpose:            To allow execution of a script file from an icon.
Path:            C:ICONX
Specification:

ICONX allows you to execute a script file of AmigaDOS commands via an
icon.

To use ICONX, create or copy a project icon for the script. Open the
icon's Information window and change the Default Tool of the icon to
C:ICONX and select Save to store the changed .info file. The script can
then be executed by double-clicking on the icon.

When the icon is opened, ICONX changes the current directory to the
directory containing the project icon before executing the script. An
input/output window for the script file will be opened on the Workbench
screen.

Several Tool Types can be specified in the icons for the script files.
The WINDOW Tool Type lets you provide an alternate window specification
for the input/output window. By default, the window's specification is:

    WINDOW=CON:0/50//80/IconX/AUTO/WAIT/CLOSE

This has the effect of opening a window only if there actually is some
output performed by the script. If a window does open, it will remain
opened after the script terminates, until the user clicks on its close
gadget.

The WAIT Tool Type lets you specify the number of seconds the
input/output window should remain open after the script terminates.
Using this option will cause the default input/output window to not
have a close gadget. There is also a DELAY Tool Type which works in a
very similar way, except that its parameter is in 1/50th of a second,
instead of in seconds.

The STACK Tool Type lets you specify the number of bytes to use for
stack for the script execution. If this Tool Type is not provided, the
default 4096 bytes is used.

Finally, the USERSHELL Tool Type lets you cause the script file to be
run using the current User Shell instead of the normal ROM Shell. You
must specify USERSHELL=YES for this to happen. User Shells are third
party shells that you can purchase and install in your system to
replace the standard shell environment that comes with the operating
system.

Extended selection can be used to pass files that have icons to the
script. Their filenames appear to the script as keywords. To use this
facility, the .KEY keyword must appear at the start of the script. In
this case, the AmigaDOS EXECUTE command is used to execute the script
file.

See Also: EXECUTE
IF


Format:        IF [NOT] [WARN] [ERROR] [FAlL] [<string> EQ|GT|GE
<string>] [VAL] [EXlSTS <filename>]
Template:        NOT/S, WARN/S, ERROR/S, FAlL/S, EQ/K, GT/K, GE/K,
VAL/S, EXlSTS/K
Purpose:            To evaluate conditional operations in script files.
Path:            Internal
Specification:

In a script file, IF, when its conditional is true, carries out all the
subsequent commands until an ENDIF or ELSE command is found. When the
conditional is not true, execution skips directly to the ENDIF or to an
ELSE. The conditions and commands in IF and ELSE blocks can span more
than one line before their corresponding ENDlFs.

ELSE is optional, and nested IFs jump to the nearest ENDIF.

The additional keywords are as follows:

NOT            Reverses the interpretation of the result.
WARN        True if previous return code is greater than or equal to
5.
ERROR    True if previous return code is greater than or equal to
10; only available if you set FAILAT to greater than 10.
FAIL        True if previous return code is greater than or equal to
20; only available if you set FAILAT to greater than 20.
<a> EO <b>True if the text of a and b is identical (disregarding
case).
EXISTS <file>    True if the file exists.

If more than one of the three condition-flag keywords (WARN, ERROR,
FAIL) are given, the one with the lowest value is used.

IF supports the GT (greater than) and GE (greater than or equal to)
comparisons. Normally, the comparisons are performed as string
comparisons. However, if the VAL option is specified, the comparison is
a numeric comparison.

You can use NOT GE for LT and NOT GT for LE.

You can use local or global variables with IF by prefacing the variable
name with a $ character.

Example 1:

    IF EXISTS Work/Prog
        TYPE Work/Prog
    ELSE
        ECHO "It's not here"
    ENDIF

If the file Work/Prog exists in the current directory, then AmigaDOS
displays it. Otherwise, AmigaDOS displays the message "It's not here"
and continues after the ENDIF.
Example 2:

    IF ERROR
        SKIP errlab
    ENDIF
    ECHO  "No error"
    LAB errlab

If the previous command produced a return code greater than or equal to
10, then AmigaDOS skips over the ECHO command to the errlab label.


See also: EXECUTE, FAILAT, LAB, QUIT, SKIP
INFO


Format:            INFO [<device>]
Template:            DEVICE
Purpose:            To give information about the file system(s).
Path:            C:INFO
Specification:

INFO displays a line of information about each floppy disk drive and
hard disk partition. This includes the maximum size of the disk, the
used and free space, the number of soft disk errors that have occurred,
and the status of the disk.

With the DEVICE argument, INFO provides information on just one device
or volume.

Example:

    1>INFO
    Unit        Size    Used    Free    Full    Errs    Status      Name
    DF0:        879K    1738   20  98%   0    Read Only   Workbench
    DF1:        879K     418    1140  24%   0    Read/Write  Text-6

    Volumes available:
    Workbench [Mounted]
    Text-6 [Mounted]
INITPRINTER


Format:            INITPRlNTER
Template:            (none)
Purpose:        To initialize a printer for print options specified
in the Preferences editors.
Path:            Extras:Tools/InitPrinter
Specification:

INITPRINTER runs the InitPrinter program. It does not support any
arguments. You will hear the printer reset, then the Shell prompt will
return. The printer gets initialized automatically on first access, but
if you switched it off in the interim, you have to initialize the
printer again with INITPRINTER.


Example :

      1> INITPRINTER
INPUT


Format:        INPUT [FROM <filename>] [EDlT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:        To specify different speeds for the mouse and
keyboard and to select a national keyboard.
Path:            Extras:Prefs/Input
Specification:

INPUT without any arguments or with the EDIT argument opens the Input
editor. The FROM argument lets you specify a file to open. This must be
a file that was previously saved with the Save As menu item of the
Input editor. For example, if you have saved a special configuration of
the Input editor to a file in the Presets drawer, you can use the FROM
argument to open that file. If the USE switch is also given, the editor
will not be opened, but the settings in the FROM file will be used. If
the SAVE switch is given, the editor will not open, but the settings in
the FROM file will be saved.


Example:

    1> INPUT Prefs/Presets/Input.fast SAVE

loads and saves the settings from the Input.fast file. Even if the
system is rebooted, those settings will still be in effect. The editor
does not open.
INSTALL


Format:        INSTALL [DRIVE] <DF0:|DF1:|DF2:|DF3:|CC0:> [NOBOOT]
[CHECK] [FFS]
Template:            DRlVE/A, NOBOOT/S, CHECK/S, FFS/S
Purpose:        To write the boot block to a formatted floppy disk,
or credit card, specifying whether it should be
bootable.
Path:            C:INSTALL
Specification:

INSTALL clears a floppy disk's or credit card's boot block area and
writes a valid boot block onto the media.

The NOBOOT option removes the boot block from an AmigaDOS disk or card,
making it not bootable.

The CHECK option checks for valid boot code. It reports whether a disk
or card is bootable or not and whether standard Commodore-Amiga boot
code is present on the media. The condition flag is set to 0 if the
boot code is standard (or the disk or card isn't bootable), 5 (WARN)
otherwise.

The FFS switch is ignored. It remains part of the template to ensure
compatibility with earlier scripts and programs.


Example 1 :

    1> INSTALL DF0: CHECK
    No bootblock installed

indicates that there is a non-bootable floppy in DF0:.


Example 2:

    1> INSTALL DF0:

makes the disk in drive DF0: a bootable disk.


Example 3:

    1> INSTALL DF0: CHECK
    Appears to be FFS bootblock

indicates that there is an FFS floppy in DF0:.
INTELLIFONT


Format:            INTELLIFONT [VALIDATE]
Template:            VALIDATE/S
Purpose:            To manage use of Intellifont outline fonts.
Path:            SYS:System/Intellifont
Specification:

INTELLIFONT, which is in the System drawer on the Workbench disk,
manages Intellifont outline fonts on your Amiga. With INTELLIFONT, you
can install new outline fonts on your system, specify new sizes for
existing fonts, and delete fonts that are no longer needed. You can
create bitmap versions of any size outline font that can be used in
applications that do not support outline fonts directly.

INTELLIFONT is valid on Workbench 3.0 level software and replaces the
predecessor program FOUNTAIN.
IPREFS


Format:            IPREFS [QUIT]
Template:            QUIT/S
Purpose:        To communicate Preferences information stored in
the individual editor files to the Workbench and
Intuition.
Path:            C:IPREFS
Specifications:

IPREFS reads the individual system Preferences files and passes the
information to the Workbench so that it can reply accordingly. IPREFS
is generally run in the Startup-sequence after the Preferences files
are copied to ENV:. Each time a user selects Save or Use from within an
editor, IPREFS is notified and passes the information along to
Workbench. If necessary, IPREFS will reset Workbench in order to
implement those changes. If any project or tool windows are open,
IPREFS will display a requester asking you to close any non-drawer
windows.

QUIT will halt all IPREFS operations. Since IPREFS runs in the
background, there is no reason to use this option.
JOIN


Format:            JOIN [FILE] {<file|pattern>} AS|TO <filename>
Template:            FlLE/M/A, AS=TO/K/A
Purpose:            To concatenate two or more files into a new file.
Path:            C:JOIN
Specification:

JOIN copies all the listed files, in the order given, to one new file.
This destination file cannot have the same name as any of the source
files. You must supply a destination filename. The original files
remain unchanged. Any number of files may be JOINed in one operation.

TO can be used as a synonym for AS.

Example:

    1> JOIN Part1 Part2 Part3 AS Textfile
KEYSHOW


Format:            KEYSHOW
Template:            (none)
Purpose:            To display the current Keymap.
Path:            Extras:Tools/KeyShow
Specification:

KEYSHOW opens the KeyShow window. The command does not support any
arguments. To exit the program, select the window's close gadget.
LAB


Format:            LAB [<string>]
Template:            (none)
Purpose:            To specify a label in a script fle.
Path:            Internal
Specifcation:

LAB is used in scripts to define a label that is looked for by the SKIP
command. The label <string> may be of any length but must be
alphanumeric. No symbols are allowed. If the <string> contains spaces,
it must be enclosed in quotes.


See also: SKIP, IF, EXECUTE
LIST


Format:        LIST [{<dir|pattern|filename>}] [P|PAT <pattern>]
[KEYS] [DATES] [NODATES] [TO <name>] [SUB <string>]
[SINCE <date>] [UPTO <date>] [QUlCK] [BLOCK]
[NOHEAD] [FILES] [DIRS] [LFORMAT <string>] [ALL]
Template:        DIR/M, P=PAT/K, KEYS/S, DATES/S, NODATES/S, TO/K,
SUB/K, SINCE/K, UPTO/K, QUICK/S, BLOCK/S, NOHEAD/S,
FILES/S, DIRS/S, LFORMAT/K, ALL/S
Purpose:        To list specified information about directories and
files.
Path:            C:LIST
Specification:

LIST displays information about the contents of the current directory.
If you specify a <dir>, <pattern>, or <filename> argument, LIST will
display information about the specified directory, all directories or
files that match the pattern, or the specified file, respectively.

Unless other options are specified, LIST displays the following:

name            The name of the file or directory.
size        The size of the file in bytes. If there is nothing in
this file, the field will read empty. For directories,
this entry reads Dir.
protectionThe protection bits that are set for this file are shown
as letters. The clear (unset) bits are shown as hyphens.
Most files will show the default protection bits,
----rwed for readable/writable/executable/delete-able.
See the PROTECT command for more on protection bits.
date and time    The date and time the file was created or last changed.
comment    The comment, if any, placed on the file using the
FILENOTE command. It is preceded by a colon (:).

LIST has options which will change the way the output is displayed.
These options are:

KEYS        Displays the block number of each file header or
directory. This is mostly useful to programmers.
DATES    Displays dates in the form DD-MMM-YY (the default unless
you use QUICK).
NODATES        Will not display date and time information.
TO <name>    Specifies an output file or device for LIST; by default,
LIST outputs to the current window.
SUB <string>    Lists only files containing the substring <string>.
SINCE <date>    Lists only files created on or after the specified date.
UPTO <date>    Lists only files created on or before the specified date
QUICK        Lists only the names of files and directories.
BLOCK        Displays file sizes in blocks, rather than bytes.
NOHEAD        Suppresses the printing of the header information.
FILES        Lists files only (no directories).
DIRS            Lists directories only (no files).
LFORMAT        Defines a string to specially format LIST output.
ALL            Lists all files in directories and subdirectories.
The LFORMAT option modifies the output of LIST and can be used as a
quick method of generating script files. When LFORMAT is specified, the
QUICK and NOHEAD options are automatically selected. When using LFORMAT
you must specify an output format specification string; this string is
incorporated into the script file. If you want the output to be saved,
you must redirect it to a file by using the > operator or specifying a
TO file.

The format for the output format specification string is
LFORMAT=<string>. To include the output of LlST in this string, use the
substitution operator %S. The path and filename can be made part of the
string this way. Whether the path or the filename is substituted for an
occurrence of %S depends on how many occurrences are in the LFORMAT
line, and their order, as follows:


                Substituted with each occurrence

Occurrences of %S   1st        2nd        3rd        4th

        1        filename
        2        path        filename
        3        path        filename    filename
        4        path        filename    path        filename

When using %S, the path is always relative to the current directory.

Some new options allow you to specify fields to be printed in the
LFORMAT output. These options are:

%A    Prints file attributes (protection bits).
%B    Prints size of file in blocks.
%C    Prints any comments attached to the file.
%D    Prints the date associated with the file.
%E    Prints just the file extension.
%K    Prints the file key block.
%L    Prints the length of file in bytes.
%M    Prints filename only, omitting any extension.
%N    Prints the name of the file.
%P    Prints the file parent path.
%T    Prints the time associated with the file.

You can put a length specifer and/or a justification specifier between
the percent sign (%) and the field specifier. To specify left
justification, place a minus sign (-) before the length specifier.
Otherwise, the information displayed will be right justified.


Example 1:

    1> LIST Dirs
    Monitors        Dir       rwed  27-Jun-90   11:43:59
    T               Dir       rwed  16-Jul-90   11:37:43
    Trashcan        Dir       rwed  21-Jun-90   17:54:20

Only the directories in the current directory, in this case SYS:, are
listed. (A shortened version of the typical output is shown above.)
Example 2:


    1> LIST Li#? TO RAM:Libs.file

LIST will search for any directories or files that start with LI. The
output of LlST will be sent to Libs.file in RAM:.


Example 3:

    1> LIST DF0:Documents UPTO 09-Oct-90

Only the files or directories on the Documents directory of DF0: that
have not been changed since October 9, 1990 will be listed.


Example 4:

    1> LIST >RAM:Scriptnotes #? LFORMAT="filenote %S%S Testnote"

A new script file, Scriptnotes, is created in RAM:. The contents will
include a list of all the files in the current directory. When
Scriptnotes is executed, it will add the filenote Testnote to each
file. For example, if the current directory is S:, the contents of
Scriptnotes as produced by this command might look like this:

    filenote s:HDBackup.config Testnote
    filenote s:DPat Testnote
    filenote s:Ed-startup Testnote
    filenote s:PCD Testnote
    filenote s:Shell-startup Testnote
    filenote s:SPat Testnote
    filenote s:Startup-sequence Testnote


Example 5:

    1> LIST Testfile LFORMAT "%-25N %L %12A %D
    Testfile                 28       ----rwed 28-May-92

%-25N specifies that the length of the field containing the name of
the file is to be 25 characters long (25), and the text is to be left
justified (-). %12A specifies that the length of the field containing
the file attributes is to be 12 characters long (12), and the text is
to be right justified.
LOADWB


Format:            LOADWB [-DEBUG] [DELAY] [CLEANUP] [NEWPATH]
Template:            -DEBUG/S, DELAY/S, CLEANUP/S, NEWPATH/S
Purpose:            To start Workbench.
Path:            C:LOADWB
Specification:

LOADWB starts the Workbench. Normally, this is done when booting, by
placing the LOADWB command in the Startup- sequence file. If you shut
down the Workbench, LOADWB can beused from a Shell to restart it.

The -DEBUG option makes a special developer menu, Debug, available in
the Workbench menu bar. If the DELAY option is specified, LOADWB waits
three seconds before executing, giving disk activity time to stop. The
CLEANUP option automatically performs a "cleanup" of the window.

Workbench snapshots the current paths in effect when the LOADWB command
is executed. It uses these paths for each Shell started from Workbench.
NEWPATH allows you to specify a new path which is snapshot from the
current Shell.


Example 1 :
If you have quit the Workbench and are working through a Shell,
entering:

    1> LOADWB

will bring the Workbench back. Entering LOADWB when the Workbench is
already loaded has no effect.


Example 2:

    1> PATH DF2:bin ADD
    1> LOADWB NEWPATH

loads the Workbench. Any Shells started from the icon will have the
same path as the Shell used to run the LOADWB NEWPATH command.
LOCALE


Format:        LOCALE [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:            To allow choice of languages available on system.
Path:            SYS:Prefs/locale
Specification:

LOCALE allows you to choose the languages you want to use in your
system. The default setting is USA English; however, you can choose
from a number of other languages.

The Locale editor allows you to select your country of origin, your
time zone, and your preferred languages. When you install your
workbench software, you choose the languages that you want available on
your system.

LOCALE without any arguments or with the EDIT argument opens the Locale
editor. The FROM argument lets you specify a file to open. This must be
a file that was previously saved with the Save As menu item of the
Locale editor. For example, if you have saved a special configuration
of the Locale editor to a file in the Presets drawer, you can use the
FROM argument to open that file. If the USE switch is also given, the
editor will not be opened, but the settings in the FROM file will be
used. If the SAVE switch is given the editor will not open, but the
settings in the FROM file will be saved.

Full information on localization is given in Using the Amiga Worhbench
Manual.
LOCK


Format:            LOCK <drive> [ON|OFF] [<passkey>]
Template:            DRIVE/A, ON/S, OFF/S, PASSKEY
Purpose:            To set the write protect status of a device.
Path:            C:LOCK
Specification:


LOCK sets or unsets the write protect status of a device or partition.
The LOCK remains on until the system is rebooted or until the LOCK is
turned off with the LOCK OFF command.

An optional passkey may be specified. If the passkey is used to lock a
hard disk partition, the same passkey must be specifed to unlock the
partition. The passkey may be any number of characters in length.


Example:

    1>  LOCK Work: ON SecretCode

The Work: partition is locked. You can read the contents of Work:
with commands like DIR, LIST or MORE, but you cannot alter the
contents of the partition. If you try to edit the contents of a file on
Work:, a requester will appear stating that Work: is write-protected.
For example, if you try to create a new directory by entering the
following:

    1> MAKEDIR WORK:Test

the following message will appear:
    Can't create directory Work:Test
    Disk is write-protected

To unlock the partition, enter:

    1> LOCK Work: OFF SecretCode

The locking of a device is only good for the duration of the current
session. Resetting or turning off the Amiga cancels the locking of
the device.
MAGTAPE


Format:        MAGTAPE [DEVICE <device name>] [UNIT <n>]
[RET|RETENSION] [REW|REWlND] [SKIP <n>)
Template:        DEVICE/K, UNIT/N/K, RET=RETENSION/S, REW=REWIND/S,
SKIP/N/K
Purpose:        To retension, rewind, or skip forward on SCSI
tapes.
Path:            C:MAGTAPE
Specification:

By default, MAGTAPE uses SCSl.device unit 4. To change the default, you
must use both the DEVICE and UNIT keywords.

The RET|RETENSION option runs the tape to the end, then rewinds it. The
REW|REWIND option rewinds the tape. The SKIP <n> option allows you to
skip files on the tape.

MAGTAPE tests to see if the unit is ready before sending the command.
If your tape is not on-line, you may have to repeat the MAGTAPE
command.


Example:

    1> MAGTAPE DEVICE second scsi.device UNIT 0 REW
MAKEDIR


Format:            MAKEDIR {<name>}
Template:            NAME/M
Purpose:            To create a new directory.
Path:            C:MAKEDIR
Specification:

MAKEDIR creates a new, empty directories with the names you specify.
The command works within only one directory level at a time, so any
directories on the given paths must already exist. The command fails if
a directory or a file of the same name already exists in the directory
in which you are attempting to create a new directory.

MAKEDIR does not create a drawer icon for the new directory.


Example 1:

    1> MAKEDIR Tests

creates a directory Tests in the current directory.


Example 2:

    1> MAKEDIR DF1:Xyz

creates a directory Xyz in the root directory of the disk in DF1:.


Example 3:

    1> CD DF0:
    1> MAKEDIR Documents Payables Orders

creates three directories, Documents, Payables, and Orders, on the disk
in DF0:.
MAKELINK


Format:            MAKELINK [FROM] <file> [TO] <file> [HARD] [FORCE]
Template:            FROM/A, TO/A, HARD/S, FORCE/S
Purpose:            To create a link between files.
Path:            C:MAKELINK
Specification:

MAKELINK creates a file on a disk that is a pointer to another file,
known as a link. When an application or command calls the FROM file,
the TO file is actually used. By default, MAKELINK supports hard links
- the FROM file and TO file must be on the same volume.

Soft links, which can be links across volumes, are not currently
implemented.

Normally, MAKELINK does not support directory links, as they can be
dangerous to applications. To create a directory link, you must use the
FORCE option. If MAKELINK detects that you are creating a circular
link, such as a link to a parent directory, you will receive a Link
loop not allowed message.
MEMACS


Format:            MEMACS [<filename>] [OPT W] [goto <n>]
Template:            FROM/M, OPT/K, GOTO/K
Purpose:            To enable screen-oriented text editing.
Path:            Extras: Tools/MEmacs
Specification:

MEmacs, which stands for MicroEmacs, is a screen-oriented text editor
found in the Tools drawer of the Extras disk. A text editor has the
basic functionality of a word processor, but it does not support style
formatting options. MEmacs is described in detail in Chapter 6.
MORE


Format:            MORE <filename>
Template:            FILENAME/K
Purpose:            To display the contents of an ASCII file.
Path:            SYS:Utilities/More
Specification:

MORE displays the contents of the file <filename>. If the file is not
in the current directory, you must specify the complete path. If you
don't specify a file, MORE will display a file requester.

Command keys for MORE are explained on screen when you press the H key.

MORE also accepts input from a PIPE. Since standard input from a PIPE
is of unknown length, the Previous Page (Backspace or b), Last Page
(>), and More N% into file (%N) commands are disabled when the MORE
input is from a PIPE.

If the EDITOR environment variable is defined and you are using MORE
from the Shell, you can bring up an editor to use on the file you are
viewing (press Shift+E). The EDITOR variable should have the complete
path to the editor specified; i.e., C:ED.


Example:

    1> MORE DF0:TestFile

displays the contents of the ASCII file called TestFile on the disk in
drive DF0:.
MOUNT


Format:            MOUNT {device} [FROM <filename>]
Template:            DEVICE/M, FROM/K
Purpose:            To make a device connected to the system available.
Path:            C:MOUNT
Specification:

MOUNT causes AmigaDOS to recognize new devices, handlers, or file
systems that are being added to the system. The DEVICE keyword
specifies the devices to be mounted.

A MountList file contains the parameters of the device that is being
mounted. By default, MOUNT looks for the MountList file in
DEVS:DOSDrivers. If it does not find the file, it will then look in
SYS:Storage/DOSDrivers.

Each DOSDriver file has an icon associated with it that represents the
Mount file describing the device. The ability to drag DOSDriver icons
means that you can control what device gets mounted in your system.
This is important for CrossDOS. For example, by double clicking on the
PC0 icon, you can activate MS-DOS device unit 0. By dragging the PC0
icon from Storage/DOSDrivers to Devs/DOSDrivers, you make the selection
permanent, and PC0: is then available after every reboot.

Multiple devices can be mounted with just one invocation. Different
actions are taken depending on whether the device name argument ends
with a colon.


Example 1:

    1> Mount PIPE:

This looks for the file DEVS:DOSDrivers/PlPE and processes it if found.
If the Mount file is processed successfully, the Tool Types for
DEVS:DOSDrivers/PIPE.info are then processed and override any settings
from the Mount file.

If DEVS:DOSDrivers/PIPE does not exist, an attempt is made to find
SYS:Storage/DOSDrivers/PIPE. If this also fails, then an attempt is
made to find a PIPE entry in DEVS:MountList.


Example 2:

    1> Mount PIPE

When there is no colon at the end of a device name argument, the name
is taken as the filename of the Mount file to process. This filename
can contain wildcards so something like the following is possible:
Mount DEVS:DOSDrivers/~(#?.info).
Example 3:

    1> Mount PIPE FROM <MountList>

This scans for a PIPE entry in <MountList>.

Any keyword that can be put in a MountList can also be put as a Tool
Type entry. The Tool Types data overrides the MountList file itself.


See Appendix B for further information on MountList.
MULTIVIEW


Format:        MULTIVIEW [FILE <filename>] [CLIPBOARD] [CLIPUNIT
<clipboard unit>] [SCREEN] [PUBSCREEN <public
screen name>] [REQUESTER] [BOOKMARK] [FONTNAME
<font name>] [FONTSIZE <font size>] [BACKDROP)
[WINDOW]
Template:        FILE, CLIPBOARD/S, CLIPUNIT/K/N, SCREEN/S,
PUBSCREEN/K, REQUESTER/S, BOOKMARK/S, FONTNAME/K,
FONTSIZE/K/N, BACKDROP/S, WINDOW/S
Purpose:        To display picture files, text files, AmigaGuide
help files, sound files, and animated graphics
files.
Path:            SYS:Utilities/Mu1tiView
Specifications:

MULTIVIEW displays the contents of a file. If the file is not in the
current directory, you must specify the complete path. If you don't
specify a file, MULTIVIEW will display a file requester.

If CLIPBOARD is specified, the Clipboard will be viewed instead of the
file. CLIPUNIT specifies the Clipboard unit to use when using the
CLIPBOARD keyword.

SCREEN indicates that you want the object to appear on its own screen,
using the display mode specifed by the object. For example, if an ILBM
was Low Res, then the screen would match.

If REQUESTER is specified, MULTIVIEW will display a file requester.

BOOKMARK recalls the object and position when opening a file with a
bookmark.

FONTNAME specifes which font to use when viewing text objects. FONTSIZE
specifies the font size in points to use when viewing text objects.

BACKDROP indicates that the window should be a backdrop window.

WINDOW will open the Mu1tiView window without an object so that it can
be placed in the WBStartup directory.

MULTIVIEW is valid on Workbench 3.0 level software.
NEWCLI


Format:            NEWCLI [<window specification>] [FROM <filename>]
Template:            WINDOW, FROM
Purpose:            To start a new Shell process.
Path:            Internal
Specifications:

NEWCLI starts a new Shell process. It is the same as using the NEWSHELL
command. See the specifications for NEWSHELL for more information.
NEWSHELL


Format:            NEWSHELL [<window specification>] [FROM <filename>]
Template:            WINDOW,F ROM
Purpose:            To open a new interactive Shell window.
Path:            Internal
Specifications:

NEWSHELL invokes a new, interactive Shell. The new window becomes the
currently-selected window and process. The new window has the same
current directory, prompt string, path, and stack size as the one from
which it was invoked. However, each Shell window is independent,
allowing separate input, output, and program execution.

The window can be sized, dragged, zoomed, and depth-adjusted just like
most other Amiga windows.

To create a custom window, you can include the WINDOW argument. You may
specify the initial dimensions, location, and title of the window with
this <window specification> syntax:

CON:x/y/width/height/title/options

where:
x    Is the number of pixels from the left edge of the screen to
the left border of the Shell window.
y    Is the number of pixels from the top of the screen to the top
of the Shell window.
width    Is the width of the Shell window, in pixels.
height    Is the height of the Shell window, in pixels.
title    Is the text that appears in the Shell window title bar.

The permissible options are:
AUTO    The window automatically appears when the program needs input
or produces output. With the Shell window, it will open for
input immediately. The window can only be closed with the
ENDSHELL command. Selecting the Shell's close gadget will
close the window, but it will re-open immediately since it is
expecting input.
CLOSEThe window has all the standard gadgets, including a close
gadget.
BACKDROPThe window appears on the backdrop, behind all the Workbench
windows. The only gadget in the window border is the zoom
gadget. This Shell window cannot be brought to the front of
the screen; you have to resize the Workbench windows to see
it.
NOBORDERThe window opens without any left or bottom window border.
Only the zoom, depth, and sizing gadgets are available.
NODRAGThe window cannot be dragged. It has a zoom, depth and sizing
gadget, but no close gadget.
NOSIZE    The window only has a depth gadget.
SCREENThe window will open on a public screen. The screen must
already exist. You must specify the name of the screen after
the SCREEN keyword.
SIMPLEIf you enlarge the window, the text will expand to fill the
newly available space, allowing you to see text that had been
scrolled out of the window.
SMARTIf you enlarge the window, the text does not expand to fill
the newly available space.
WAIT    The window can only be closed by selecting the close gadget.
(An example of this is the Execute Command Workbench Output
Window.)

NEWSHELL uses the default startup file S:Shell-startup, unless a FROM
filename is specifed. S:Shell-startup is a standard AmigaDOS script
fle. You might have several different Shell-startup files, each having
different command aliases, for example. You can call such customized
Shell environments with FROM.

The NEWCLI command has the same effect as NEWSHELL; it invokes a new
Shell process.


Example 1 :

    1>  NEWSHELL

a new Shell window will open.


Example 2 :

    1> NEWSHELL CON:0/0/640/200/My5hell/CLOSE

A window starting in the upper left corner of the screen and measuring
640 pixels wide and 200 pixels high will open. The window will be
titled MyShell, and it will have a close gadget. If you add the command
to your User-startup file, a Shell window will open automatically when
your Amiga is booted.


Example 3:

    1> NEWSHELL FROM S:Programming.startup

opens a new Shell, but instead of executing the Shell-startup file, the
Programming.startup file is executed. You could have aliases and prompt
commands in the Programming.startup file that you only use when you are
programming.
NOCAPSLOCK


Format:            NOCAPSLOCK [CX_PRlORlTY<priority>]
Template:            CX_PRlORlTY/N/K
Purpose:            To disable the Caps Lock key.
Path:            Extras:Tools/Commodities/NoCapsLock
Specification:

NOCAPSLOCK is a Commodity Exchange program that temporarily disables
the Caps Lock key.

CX PRIORITY sets the priority ofNoCapsLock in relation to all the other
Commodity Exchange programs. All the Commodity Exchange programs are
set to a default priority of 0.

To exit NoCapsLock once it has been started from the Shell, enter
Ctrl+C or use the BREAK command.


Example:

    1> NOCAPSLOCK
NOFASTMEM


Format:            NOFASTMEM
Template:            (none)
Purpose:            To force the Amiga to use only resident Chip RAM.
Path:            SYS:System/NoFastMem
Specification:

NOFASTMEM disables any Fast (or expansion) RAM used by the system. The
expansion memory can be turned on again by sending the NoFastMem
program a break, either via the BREAK command or by pressing Ctrl+C.


Example:

    1>  NOFASTMEM
OVERSCAN


Format:        OVERSCAN [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:        To change the sizes of the display areas for text
and graphics.
Path:            Extras:Prefs/Overscan
Specification:

OVERSCAN without any arguments or with the EDIT argument opens the
Overscan editor. The FROM argument lets you specify a file to open.
This must be a file that was previously saved with the Save As menu
item of the Overscan editor. For example, if you have saved a special
configuration of the Overscan editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not open, but the settings in the FROM file
will be used. If the SAVE switch is given, the editor will not open,
but the settings in the FROM file will be saved.


Example:

    1> OVERSCAN Prefs/Presets/Overscan.graphics SAVE

loads and saves the Overscan sizes saved in the Overscan.graphics file.
PALETTE


Format:            PALETTE [FROM <filename>] [EDIT] [USE] [SAVE]
Template:            FROM, EDIT/S, USE/S, SAVE/S
Purpose:            To change the colors of the Workbench screen.
Path:            Extras:Prefs/Palette
Specification:

PALETTE without any arguments or with the EDIT argument
opens the Palette editor. The FROM argument lets you specify a
file to open. This must be a file that was previously saved with the
Save As menu item of the Palette editor. For example, if you have
saved a special configuration of the Palette editor to a file in the
Presets drawer, you can use the FROM argument to open that file.
If the USE switch is also given, the editor will not be opened, but
the settings in the FROM file will be used. If the SAVE switch is
given, the editor will not open, but the settings in the FROM file
will be saved.


Example:

    1> PALETTE Prefs/Presets/Palette.grey USE

loads and uses the colors saved in the Palette.grey file. If the
system is rebooted, the previously saved colors will be used.
PATH


Format:        PATH [{<dir>}] [ADD] [SHOW] [RESET] [REMOVE]
[QUIET]
Template:            PATH/M, ADD/S, SHOW/S, RESET/S, REMOVE/S, QUIET/S
Purpose:        To control the directory list that the Shell
searches to find commands.
Path:            Internal
Specification:

PATH lets you see, add to, or change the search path that AmigaDOS
follows when looking for a command or program to execute. When a
directory is in the search path, you no longer need to specify the
complete path to any files or subdirectories within that directory. You
can simply enter the filename, and AmigaDOS will look through the
directories in the search path until it finds the file.

Enter the PATH command alone, or with the SHOW option, and the
directory names in the current search path will be displayed. Normally,
when PATH is displaying the directory names, a requester will appear if
a volume that is part of the search path cannot be found. For example,
if you added a floppy disk to the search path, then removed that disk
from the disk drive, a requester would ask you to insert the disk.

If you specify the QUIET option, PATH will not display requesters for
volumes that are not currently mounted. If PATH encounters an unmounted
volume, it will simply display the volume name. The names of any
directories on that volume included in the PATH will not be displayed.

The ADD option specifies directory names to be added to the current
PATH. You can add up to ten directories with one PATH ADD command (the
ADD keyword is optional); names of the directories must be separated by
at least one space. When you issue the PATH command, AmigaDOS searches
for each of the ADDed directories.

To replace the existing search path with a completely new one, use PATH
RESET followed by the names of the directories. The existing search
path, except for the current directory and SYS:C, is erased and the new
one is substituted.

The REMOVE option eliminates the named directory from the search path.


Example:

    1> PATH EXTRAS:Tools ADD

adds the Tools directory on the Extras disk to the search path of the
Shell. If the Extras disk is not in a disk drive, a requester will ask
you to insert it in any drive.

If you remove Extras from the drive, and enter:

    1> PATH

a list of directories in the search path will be displayed. A requester
will ask you to insert Extras. However, if you enter:
    1> PATH QUIET

the list of directories in the search path will be displayed. However,
when the path comes to Extras:Tools, only the volume name, Extras:,
will appear in the list.


See also: ASSIGN
POINTER


Format:        POINTER [FROM <filename>] [EDIT] [USE] [SAVE]
[CLIPUNIT <clipboard unit>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, CLIPUNIT/K
Purpose:            To change the appearance of the screen pointer.
Path:            Extras:Prefs/Pointer
Specification:

POINTER without any arguments or with the EDIT argument opens the
Pointer editor. The FROM argument lets you specify a file to open. This
must be a file that was previously saved with the Save As menu item of
the Pointer editor. For example, if you have saved a special
configuration of the Pointer editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not be opened, but the settings in the FROM
file will be used. If the SAVE switch is given, the editor will not
open, but the settings in the FROM file will be saved.

CLIPUNIT determines which Clipboard Unit the pointer will use during
cut and paste operations.


Example:

    1> POINTER Prefs/Presets/Pointer.star USE

loads and uses the pointer saved in the Pointer.star file. If the
system is rebooted, the previously saved pointer will appear.
PRINTER


Format:        PRINTER [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>) [UNIT <unit>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K, UNIT/S
Purpose:            To specify a printer and print options.
Path:            Extras:Prefs/Printer
Specification:

PRINTER without any arguments or with the EDIT argument opens the
Printer editor. The FROM argument lets you specify a file to open. This
must be a file that was previously saved with the Save As menu item of
the Printer editor. For example, if you have saved a special
configuration of the Printer editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not be opened, but the settings in the FROM
flle will be used. If the SAVE switch is given, the editor will not
open, but the settings in the FROM file will be saved.

PRINTER UNIT opens the Printer editor with a Device Unit gadget added
to the editor. Select the unit to which output should be sent. If
PRINTER UNIT <unit> is specified, output will be sent to the specifed
<unit>. This option is primarily available for use with old application
programs.


Example:

    1> PRINTER Prefs/Presets/Printer.epson SAVE

loads and saves the specifcations saved in the Printer.epson file.
PRINTERGFX


Format:        PRINTERGFX [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:            To specify graphic printing options.
Path:            Extras:Prefs/PrinterGfx
Specifcation:

PRINTERGFX without any arguments or with the EDIT argument opens the
PrinterGfx editor. The FROM argument lets you specify a file to open.
This must be a file that was previously saved with the Save As menu
item ofthe PrinterGfx editor. For example, if you have saved a special
configuration of the PrinterGfx editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not be opened, but the settings in the FROM
file will be used. If the SAVE switch is given, the editor will not
open, but the settings in the FROM file will be saved.


Example:

    1> PRINTERGFX Prefs/Presets/PrinterGfx.halftone USE

loads and uses the specifications saved in the PrinterGfx.halftone
file. If the system is rebooted, the last saved specifcations will be
loaded.
PRINTERPS


Format:        PRINTERPS [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:            To control features ofPostScript printers.
Path:            Extras:Prefs/PrinterPS
Specification:

PRINTERPS without any arguments or with the EDIT argument opens the
PrinterPS editor. The PrinterPS editor enables you to control features
of PostScript printers. This editor only applies if you have a
PostScript printer and if you choose PostScript in the Printer
preferences editor. The PrinterPS editor combines PostScript specific
options for controlling text and graphic output.

The FROM argument lets you specify a file to open. This must be a file
that was previously saved with the Save As menu item of the PrinterPS
editor. For example, if you have saved a special configuration of the
PrinterPS editor to a file in the Presets drawer, you can use the FROM
argument to open that file. If the USE switch is also given, the editor
will not open, but the settings in the FROM file will be used. If the
SAVE switch is given, the editor will not open, but the settings in the
FROM file will be saved.

See the Using the Amiga Worhbench manual for more information.
PRINTFILES


Format:            PRINTFILES {[-f] <filename>}
Template:            -f/S, FILENAME/A/M
Purpose:            To send file(s) to the printer.
Path:            Extras:Tools/PrintFiles
Specification:

PRINTFILES prints the specified file. The -f flag turns on the form
feed mode. When printing multiple files, be sure to specify the flag
before each filename.


Example:

    1> PRINTFILES -f DF0:testfile -f DF0:docfile

prints the testfile and docfile files, stored on the disk inserted in
drive DF0:. The -f argument will add a form feed prior to printing each
file to ensure they each begin on a new page.
PROMPT


Format:            PROMPT [<prompt>]
Template:            PROMPT
Purpose:            To change the prompt string of the current Shell.
Path:            Internal
Specification:

PROMPT allows you to customize the prompt string, the text printed by
the Shell at the beginning of a command line. The prompt string may
contain any characters, including escape sequences.

In the examples in this manual, the prompt string is shown as 1>.

The default prompt string is:
    %N.%S>

which displays the Shell number, a period, the current directory, a
right angle-bracket and a space.

The substitutions available for the <prompt> string are:
%N    Displays the Shell number.
%S    Displays the current directory.
%R    Displays the return code for the last operation.

A space is not automatically added to the end of the string. If you
want a space between the prompt and typed-in text, place it in the
string, and enclose the string in double quotes.

You can embed commands in the prompt string by enclosing the command in
backward apostrophes (`).

PROMPT alone, without a string argument, resets the prompt to the
default.

Example 1:

    1>  PROMPT  %I%I

Only the Shell number is shown. The > is removed from the prompt.

Example 2:

    1> PROMPT  "%N.%S.%R> "
    1.SYS:.0>

The Shell number, current directory, and return code of the previous
command are shown. A space is included after the >.

Example 3 :

    1> PROMPT  " `date`> "
    Tuesday 11-5ep-90 14:36:39>

The DATE command is executed and used as the prompt. The prompt is not
updated as the time changes. You would have to execute the PROMPT
command again to update the Shell prompt.
PROTECT


Format:        PROTECT [FILE] <file|pattern> [FLAGS][+|-]
[<flags>] [ADD|SUB] [ALL] [QUIET]
Template:            FlLE/A, FLAGS, ADD/S, SUB/S, ALL/S, QUIET/S
Purpose:            To change the protection bits of a file.
Path:            C:PROTECT
Specification:

All files have a series of protection bits stored with them which
control their attributes. These bits can be altered to indicate the
type of file and the file operations permitted. PROTECT is used to set
or clear the protection bits of a file.

The protection bits are represented by letters:
s    The file is a script.
p    The file is a pure command and can be made resident.
a    The file has been archived.
r    The file can be read.
w    The file can be written to (altered).
e    The file is executable (a program).
d    The file can be deleted.

To see the protection bits associated with a file, use the LIST
command. The protection field is displayed with set (on) bits shown by
their letters and clear (off) bits shown by hyphens. For example, a fle
that is readable, writeable and deletable, will have ----rw-d in the
protection feld.

To specify the entire protection field at once, give the letters of the
bits you want set as the FLAGS argument, without any other keywords.
The named bits will be set, and all the others will be cleared.

The symbols + and - (or the equivalent keywords ADD and SUB) are used
to control specific bits without affecting the state of unspecified
bits. Follow + or - with the letters ofthe bit(s) to set or clear,
respectively, and only those bits will be changed. Don't put a space
after the symbol or between the letters. The order ofthe letters does
not matter. ADD and SUB work similarly, but there must be a space
between the keyword and the letters. You cannot both set and clear bits
in the same command.

The ALL option adds or removes the specified protection bits from all
the files in the specified directory. The QUIET option suppresses the
screen output.


Example 1:

    1> PROTECT DF0:Memo +rw

sets only the protection bits r (readable) and w (writeable) to the
file Memo on DF0:. No other protection bits are changed.
Example 2:

    1> PROTECT L:#? e SUB

clears the e (executable) protection bit from all the files in the L:
directory.


Example 3:

    1> PROTECT Work:Paint rwed

The protection status of Paint becomes "----rwed".


See Also: LIST
QUIT


Format:            QUIT [<return code>]
Template:            RC/N
Purpose:        To exit from a script file with a specified return
code.
Path:            Internal
Specification:

QUIT is used to stop the execution of the script upon the specified
return code. The default return code is zero. It is recommended that
you use the standard return code values of 5, 10 and 20.


Example:

    ASK "Do you want to stop now?"
    IF  WARN
        QUIT 5
    ENDIF
    ECHO  "OK"
    ECHO "The script is continuing.'

If you press Y at the prompt, the script will be aborted, as WARN is
equal to a return code of 5. If you press N or press Return:

    OK
    The script is continuing.

will be displayed in the Shell window.
RELABEL


Format:            RELABEL [DRIVE] <drive> [NAME] <name>
Template:            DRIVE/A,NAME/A
Purpose:            To change the volume name of a disk.
Path:            C:RELABEL
Specification:

RELABEL changes the volume name of the disk in the given drive to the
<name> specified. Volume names are set initially when you format a
disk.

If you have a floppy disk system with only one disk drive, be sure to
specify the disks by volume name, instead of drive name.


Examples:

    1> RELABEL Workbench: MyDisk

changes the name of the Workbench disk to MyDisk. Notice that you don't
need the colon after the second name.

    1> RELABEL DF2: DataDisk

changes the name of the disk in DF2: to DataDisk.
REMRAD


Format:            REMRAD [<device>] [FORCE]
Template:            DEVICE,FORCE/S
Purpose:            To remove the recoverable ramdrive.device.
Path:            C:REMRAD
Specification:

If you want to remove the recoverable ramdrive.device (usually mounted
as RAD:) from memory, and you do not want to turn the system off, you
can use the REMRAD command. If you have mounted more than one
recoverable ramdrive.device, use the DEVICE specification.

REMRAD commands the ramdrive.device to delete all of its files and
become inactive. The next time the Amiga is rebooted, the
ramdrive.device is removed from memory completely. If the device is in
use at the time the REMRAD command is given, the operation will abort
with a device in use message. To remove it even if it is in use, you
must use the FORCE option.
RENAME


Format:            RENAME [{FROM}] <name> [TO|AS] <name> [QUlET]
Template:            FROM/A/M, TO=AS/A, QUIET/S
Purpose:            To change the name of a file or directory.
Path:            C:RENAME
Specification:

RENAME renames the FROM file or directory with the specifed TO name.
FROM and TO must be on the same disk. If the name refers to a
directory, RENAME leaves the contents of the directory unchanged (the
directories and files within that directory keep the same names and
contents).

If you rename a directory, or if you use RENAME to give a file another
directory name (for example, you rename :Bill/letter to :Mary/Letter),
AmigaDOS changes the position of that directory or file in the filing
system hierarchy.

The colon before the directory indicates that the directory is in the
root directory.

Example 1:

    1> RENAME Work/Prog1 AS :Arthur/Example

renames the file Prog1 as Example, and moves it from the Work directory
to the Arthur directory. The Arthur directory must exist in the root
directory for this command to work.


Example 2:

    1> RENAME 7.2Fax 8.16Fax 9.22Fax TO Faxes

moves the 7.2Fax, 8.16Fax, and 9.22Fax files to the Faxes directory.
The Faxes directory must already exist.
REQUESTCHOICE


Format:        REQUESTCHOICE <title> <body> <gadgets> [PUBSCREEN
<public screen name>]
Template:            TITLE/A, BODY/A, GADGETS/A, PUBSCREEN/K
Purpose:        To allow AmigaDOS and ARexx scripts to use the
Intuition EasyRequest() feature.
Path:            C:REQUESTCHOICE
Specifcation:

REQUESTCHOICE allows AmigaDOS and ARexx scripts to use the Intiution
EasyRequest () feature.

The <title> argument specifies the title of the requester.

The <body> argument specifes the text ofthe requester. Linefeeds can be
embedded using *n.

The <gadgets> argument specifies the text for the different gadgets.
The gadget labels are separated with |.

The number of the selected gadget is printed as a result to the
console. For evaluation in a script file you can redirect this output
into an environment variable. If the requester could not be opened, the
command will generate a return code of 20.

REQUESTCHOICE is valid on Workbench 3.0 level software.


Examples:

1> RequestChoice >ENV:rcnum "New Title" "This is my
requester,*nselect a gadget" "OK|Maybe|Cancel"
REQUESTFILE


Format:        REQUESTFILE [DRAWER <drawer name>] [FILE <file>]
[PATTERN <pattern>] [TITLE <title>] [POSITIVE
<text>) [NEGATIVE <text>] [ACCEPTPATTERN <pattern>]
[REJECTPATTERN <pattern>] [SAVEMODE) [MULTISELECT]
[DRAWERSONLY] [NOICONS] [PUBSCREEN <public screen
name>]
Template:        DRAWER, FILE/K, PATTERN/K, TITLE/K, POSITIVE/K,
NEGATIVE/K, ACCEPTPATTERN/K, REJECTPATTERN/K,
SAVEMODE/S, MULTISELECT/S, DRAWERSONLY/S,
NOICONS/S, PUBSCREEN/K
Purpose:        To allow AmigaDOS and ARexx scripts to use the ASL
file requester.
Path:            C:REQUESTFlLE
Specification:

REQUESTFILE allows AmigaDOS and ARexx scripts to use the ASL file
requester.

The DRAWER argument specifies the initial contents of the Drawer gadget

The FILE option specifies the initial contents of the File gadget.

The PATTERN option allows the use of a standard AmigaDOS pattern. It
specifies the initial contents of the Pattern gadget. If this option is
not provided, the file requester will not have any Pattern gadget.

The TITLE option specifies the title of the requester.

The POSITIVE option specifies the text to appear in the positive (left)
choice in the file requester.

The NEGATIVE option specifies the text to appear in the negative
(right) choice in the file requester.

The ACCEPTPATTERN option specifies a standard AmigaDOS pattern. Only
files matching this pattern will be displayed in the file requester.

The REJECTPATTERN option specifies a standard AmigaDOS pattern. Files
matching this pattern will not be displayed in the file requester.

If SAVEMODE is specified, the requester will operate in save mode. If
MULTlSELECT is specifed, the requester will allow multiple files to be
selected at once. If DRAWERSONLY is specifed, the requester will not
have a File gadget. This effectively turns the file requester into a
directory requester. If NOICONS is specified, the requester will not
display icons (.info files).

The selected files are returned on the command line, enclosed in double
quotes and separated with spaces. The command generates a return code
of 0 if the user selected a file, or 5 if the user cancelled the
requester.


REQUESTFILE is valid on Workbench 3.0 level software.
RESIDENT


Format:        RESlDENT [<resident name>] [<filename>] [REMOVE]
[ADD] [REPLACE] [PURE|FORCE] [SYSTEM]
Template:        NAME, FlLE, REMOVE/S, ADD/S, REPLACE/S,
PURE=FORCE/S, SYSTEM/S
Purpose:            To display and modify the list of resident commands
Path:            Internal
Specification:

RESIDENT is used to load commands and add them to the resident list
maintained by the Shell. This allows the command to be executed without
it having to be reloaded from disk each time. This eliminates the time
it takes to load the command and reduces memory use when multitasking.

To be made resident, a command should be both re-entrant and
re-executable. A re-entrant command can properly support independent
use by two or more programs at the same time.

A re-executable command does not have to be reloaded to be executed
again. Commands that have these characteristics are called pure and
have the p (pure) protection bit set.

LIST the C: directory to check for the presence of the p protection bit
to determine which commands are pure.

Many of the commands in the C: directory, as well as the MORE command
in Utilities, are pure commands and can be made resident. If a command
does not have its pure bit set, it probably cannot be made resident
safely. (Just setting the pure bit does not make a command or program
pure).

The REPLACE option is the default option and does not need to be
explicitly stated. If RESlDENT is invoked with no options, it lists the
programs on the resident list. If no <resident name> is specifed (i.e.,
just a filename is specified), RESIDENT will use the filename portion
as the name on the resident list. The full path to the file must be
used.

If a <resident name> is specified and RESIDENT finds a program with
that name already on the list, it will attempt to replace the command.
That <resident name> must then be used to reference the resident
version of the command. The replacement will succeed only if the
already-resident command is not in use.

To override REPLACEment and make several versions of a command resident
simultaneously, use the ADD option, giving a different <resident name>
for each version loaded.

If the SYSTEM option is specified, the command will be added to the
system portion of the resident list. Any commands added to the resident
list with the SYSTEM option cannot be removed. To list SYSTEM files on
the RESlDENT list, you must specify the SYSTEM option.
The PURE option forces RESIDENT to load commands which are not marked
as pure (i.e., they do not have their pure bit set), and can be used
experimentally to test the pureness of other commands and programs.

Use the PURE option with caution. Remember that in order for a command
to be made RESlDENT, it must be both re-entrant and re-executable.
Although it is unlikely, some of your prog-rams may be pure enough to
be fully re-entrant and usable by more than one process at the same
time. Other programs may not be fully re-entrant but may be pure enough
to be re-executable. Such commands can be made RESIDENT, but you must
be extremely careful to use the command in only one process at a time.

The availability of Internal commands can also be controlled with
RESIDENT. To deactivate an Internal command (for example, if an
application has its own command of the same name), use RESIDENT
<Command> REMOVE. AmigaDOS will no longer recognize the Internal
command. The AmigaDOS command can be reactivated with the REPLACE
option.


Example 1:

    1> RESIDENT C:COPY

makes the COPY command resident (replaces any previous version).


Example 2:

    1> RESIDENT Copy2 DF1:C/COPY ADD

adds another version of COPY to the resident list, under the name
Copy2.


Example 3:

    1> RESIDENT Xdir DF1:C/Xdir PURE

makes an experimental, non-pure version of the DIR command resident.


Example 4:

    1> RESIDENT CD REMOVE

makes the Internal CD command unavailable.


Example 5 :

    1> RESIDENT CD REPLACE

restores the CD command to the system.


See Also: PROTECT, LIST.
RUN


Format:            RUN <command> [+{<command>}]
Template:            COMMAND/F
Purpose:            To execute commands as background processes.
Path:            Internal
Specification:

RUN is used to launch background processes. A background process does
not open its own window for input or output and does not take over the
parent Shell.

RUN attempts to execute the <command> and any arguments entered on the
command line. You can RUN multiple commands by separating them with
plus signs (+). If you press Return after a plus sign, RUN will
interpret the next line as a continuation of the same command line.

To allow the closing of the Shell window in which the process was
started, redirect the output of RUN with the RUN >NlL: <command>.

A new background Shell has the same search path and command stack size
as the Shell from which RUN was given.

You can RUN commands stored on the resident list. For speed, resident
commands are checked before commands in the command path. A Shell
started with RUN NEWSHELL still uses the default startup file,
S:Shell-startup.


Example 1:

    1> RUN COPY Text PRT:+
    DELETE Text +
    ECHO "Printing finished"

prints the Text file by copying it to the printer device, deletes it,
then displays the given message. Plus signs are used to concatenate the
command lines.


Example 2:

    1>  RUN EXECUTE Comseq

executes, in the background, all the commands in the file Comseq.
SCREENMODE


Format:            SCREENMODE [FROM <filename>] [EDIT] [USE] [SAVE]
Template:            FROM, EDIT/S, USE/S, SAVE/S
Purpose:            To select a display mode.
Path:            Extras:Prefs/ScreenMode
Specification:

SCREENMODE without any arguments, or with the EDIT argument opens the
ScreenMode editor. The FROM argument lets you specify a file to open.
This must be a file that was previously saved with the Save As menu
item of the ScreenMode editor. For example, if you have saved a special
eonfiguration of the ScreenMode editor to a file in the Presets drawer,
you can use the FROM argument to open that file. If the USE switch is
also given, the editor will not be opened, but the settings in the FROM
file will be used. If the SAVE switch is given, the editor will not
open, but the settings in the FROM file will be saved.


Example:

    1> SCREENMODE Prefs/Presets/ScreenMode.Hires USE

You will be prompted to close all non-drawer windows, and the system
will reset and use the settings saved in the ScreenMode.Hires file. The
editor window will not open. When the system is rebooted, the display
mode will return to the last selection saved.
SEARCH


Format:        SEARCH [FROM] <name|pattern> [SEARCH]
<string|pattern> [ALL] [NONUM] [QUIET] [QUICK]
[FILE] [PATTERN]
Template:        FROM/M, SEARCH/A, ALL/S, NONUM/S, QUIET/S, QUICK/S,
FILE/S, PATTERN/S
Purpose:        To look for the specified text string in the files
of the specified directory or directories.
Path:            C:SEARCH
Specification:

SEARCH looks through all the files in the FROM directory for the given
SEARCH string. (The FROM and SEARCH keywords are optional.) If the ALL
switch is given, SEARCH also looks through all the subdirectories of
the FROM directory. SEARCH displays the name of the file being searched
and any line that contains the text sought. You must place quotation
marks around any search text containing a space. The search is case
insensitive (capitalization is ignored).

The options are:
NONUM    Line numbers are not printed with the strings.
QUIET    Searches quietly; filenames being searched are not displayed.
QUICK    Uses a more compact output format.
FILE Looks for a file by the specified name, rather than for a
string in the file.
PATTERN    Uses pattern matching in the search.

SEARCH leaves a 0 in the condition flag if the object is found, and a 5
(WARN) otherwise. This makes it useful in scripts. To abandon the
search of the current file and continue to the next file, if any, press
Ctrl+D. SEARCH is aborted when a Ctrl+C is pressed.
SERIAL


Format:        SERIAL [FROM <filename>) [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>] [UNIT <unit>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K, INIT/S
Purpose:        To set the specifications for communication through
the serial port.
Path:            Extras:Prefs/Serial
Specifcation:

SERIAL without any arguments or with the EDIT argument opens the Serial
editor. The FROM argument lets you specify a file to open. This must be
a file that was previously saved with the Save As menu item of the
Serial editor. For example, if you have saved a special configuration
of the Serial editor to a file in the Presets drawer, you can use the
FROM argument to open that file. If the USE switch is also given, the
editor will not open, but the settings in the FROM file will be used.
If the SAVE switch is given, the editor will not open, but the settings
in the FROM file will be saved.

SERlAL UNIT opens the Serial editor with a Device Unit gadget added to
the editor. Select the unit to which output should be sent. If SERIAL
UNIT <unit> is specifed, output will be sent to the specified <unit>.


Example:

    1> SERIAL Prefs/Presets/Serial.9600 USE

loads and uses the specifcations saved in the Serial.9600 file. If the
system is rebooted, the last saved settings will take effect.
SET


Format:            SET [<name>] [<string>]
Template:            NAME, STRING/F
Purpose:            To set a local variable.
Path:            Internal
Specification:

SET with <name> and <string> arguments creates a new environment
variable. The first word after SET is taken as the <name>. Everything
else on the command line is taken as the <string> argument. Quotation
marks are not required.

SET with no arguments lists the current local variables.

An environment variable created with SET is local to the Shell in which
it was created. If you create a new Shell with the NEWSHELL command,
that Shell will also recognize any variables created in its parent
Shell. However, if you create a new Shell with the Execute Command menu
item or by opening the Shell icon, variables created with SET will not
be recognized in the new Shells.

You can call environment variables in a script or on a command line by
placing a dollar sign ($) in front of the variable name.

To remove a local variable definition, use the UNSET command.


Examples:

    1> SET Origin This process launched from icon

creates the local variable Origin which stores a reminder that a Shell
was invoked from an icon rather than a NEWSHELL.

    1> ECHO $Origin
    This process launched from icon


See Also: GET, UNSET
SETCLOCK


Format:            SETCLOCK LOAD|SAVE|RESET
Template:            LOAD/S, SAVE/S, RESET/S
Purpose:        To set or read the battery backed-up hardware
clock.
Path:            C:SETCLOCK
Specification:

SETCLOCK SAVE sets the date and time of the battery backed-up hardware
clock from the current system time (saved with the Time editor or with
the DATE command). SETCLOCK SAVE is typically used after a DATE
command.

SETCLOCK LOAD sets the current system time from the battery backed-up
clock. In systems using Kickstart 2.0 or later, this is done
automatically during the boot process.

The RESET option resets the clock completely. This may be necessary if
a poorly written program that does not follow the rules turns the clock
off or sets the test bit of the clock.


Example:

    1> DATE 17-Aug-92 05:45:54
    1> SETCLOCK SAVE

saves the date, August 17, 1992, and the time, 5:45 a.m., to the
battery backed-up hardware clock. That clock keeps time even when the
Amiga is powered off. When the system is booted, the system clock is
set with the time saved in the hardware clock.

Amiga 500s do not have battery backed-up clocks, unless an A501 RAM
expansion cartridge has been installed.


See also: DATE
SETDATE


Format:            SETDATE <file|pattern> [<date>] [<time>] [ALL]
Template:            FILE/A, WEEKDAY, DATE, TIME, ALL/S
Purpose:            To change a file or directory's timestamp.
Path:            C:SETDATE
Specification:

SETDATE changes the timestamp (date and time of creation or last
change) of a file or directory. SETDATE <file> changes the date/time of
the file to the current system date/time. SETDATE ALL changes the date
and time of all the files in the specified directory.

SETDATE does not affect the software or hardware clocks.

The output of the DATE command may be used as input to SETDATE.


Example 1:

    1> SETDATE TestFile

changes the date and time associated with TestFile to the current date
and time.


Example 2 :

    1> SETDATE TestFile 16-09-89 15:25:52

changes the date and time associated with TestFile to September 16,
1989, 3:25 p.m.


See Also: DATE
SETENV


Format:            SETENV [<name>] [<string>]
Template:            NAME, STRING/F
Purpose:            To set a global variable.
Path:            Internal
Specification:

SETENV with <name> and <string> arguments creates a new global
environment variable. The first word after SETENV is taken as the
<name>. Everything else on the command line is taken as the <string>
argument. Quotation marks are not required. Comments (statements
prefaced with a semicolon (;)) are not allowed on a SETENV comand line.
This includes command lines that are part of a script.

SETENV with no arguments lists the current global variables. Global
variables are stored in the ENV: directory and are used by all
processes. However, if a local variable (defined by SET) and a global
variable share the same name, the local variable will be used.

Environment variables are called by scripts or other commands by
including a dollar sign ($) in front of the variable name.

To remove a global variable definition, use the UNSETENV command.


Example 1:

    1> SETENV Editor Extras:Tools/MEmacs

creates the environment variable Editor which can be used with the MORE
utility. This specifies the editor as being MEmacs, located in the
Tools drawer of the Extras disk. The variable Editor will be available
in any Shell.


Example 2:

    1> SETENV Editor C:ED

same as above, only the editor specified is ED.

    1> ECHO $Editor
    C:ED

See Also: GETENV, UNSETENV
SETFONT


Format:        SETFONT <font> <size> [SCALE] [PROP] [ITALIC]
[BOLD] [UNDERLINE]
Template:        NAME/A, SIZE/N/A, SCALE/S, PROP/S, ITALIC/S,
BOLD/S, UNDERLINE/S
Purpose:            To change the Shell font.
Path:            C:SETFONT
Specification:

SETFONT lets you change the font used in a particular Shell window,
overriding the System Default Text setting specified in the Font
editor. SETFONT is only effective in the window in which it is invoked.

You must specify both a font name and a size when using the SETFONT
command. The other options are:

SCALE    Enables bitmap font scaling.
PROP        Allows proportional fonts.
ITALIC    The font will be italic.
BOLD        The font will be boldface.
UNDERLINE    The font will be underlined.

Invoking SETFONT will clear the Shell window of its current contents
and display a new prompt, in the new font, at the top of the window.


Example:

    1> SETFONT Topaz 13 BOLD UNDERLINE

The Shell window will clear, and the new prompt will be in 13 point
Topaz, underlined and boldface.
SETKEYBOARD


Format:            SETKEYBOARD <keymap name>
Template:            KEYMAP/A
Purpose:            To set the keymap for the Shell.
Path:            C:SETKEYBOARD
Specification:

SETKEYBOARD specifies the keymap used by the Amiga. The available files
are listed below:

Keymap          Keyboard

cdn            French Canadian
chl            Swiss French
ch2            Swiss German
d            German
dk            Danish
e            English
f            French
gb            Great Britain
i            Italian
n            Norwegian
po            Portuguese
s            Swedish
usa0            (for programs developed before V1.0)
usa            American
usa2            Dvorak

To have the system always use a keymap other than the default, add the
SETKEYBOARD command to your Startup-sequence file, or use the Input
editor for a permanent choice.


Example:
To change to a French Canadian keymap, enter:

    1> SETKEYBOARD cdn

The keymap file must be in the KEYMAPS: directory for SETKEYBOARD to
find it.
SETPATCH


Format:            SETPATCH [QUIET] [NOCACHE) [REVERSE]
Template:            QUIET/S,NOCACHE/S,REVERSE/S
Purpose:            To make ROM patches in system software.
Path:            C:SETPATCH
Specification:

SETPATCH installs temporary modifications to the operating system. If
needed, it must be run at the beginning of the Startup-sequence file.
Updated versions of SETPATCH will be made available when necessary as
AmigaDOS development continues.

If QUIET is specified, no output will be sent to the screen.

NOCACHE will prevent Data Cache from being turned on on 68030 systems
made by some third party vendors.

REVERSE allocates memory from the top. This option is primarily
available for CDTV developers.
SKIP


Format:            SKIP [<label>] [BACK]
Template:            LABEL, BACK/S
Purpose:            To skip to a label when executing script files.
Path:            Internal
Specification:

SKIP is used in scripts to allow you to skip ahead in the script to a
<label> defined by a LAB statement. If no <label> is specified, SKIP
jumps to the next LAB statement.

SKIP always searches forward from the current line of the file.
However, when the BACK option is used, SKIP starts searching for the
label from the beginning of the file. This allows SKlPs to points prior
to the SKIP command.

You can only SKIP as far back as the last EXECUTE statement. If there
are no EXECUTE statements in a script, you will SKIP back to the
beginning of the file.

If SKIP does not fnd the label you specifed, the command sequence
terminates and the message "Label <label> not found by Skip" is
displayed.

Example:
Assume you have the following script, called CheckFile:

    .KEY name
    IF exists <name>
        SKIP message
    ELSE
        ECHO "<name> is not in this directory."
    QUIT
    ENDIF
    LAB message
    ECHO "The <name> file does exist."

You can run the script by entering:

    1> EXECUTE CheckFile Document

If the Document file exists in the current directory, the execution of
the script will SKIP ahead to the LAB command. The message:

    The Document file does exist

will be displayed in the Shell window.

If the Document file is not in the current directory, the execution of
the script will jump to the line after the ELSE statement, and the
message:
    Document is not in this directory

will be displayed.

See also: EXECUTE, LAB
SORT


Format:        SORT [FROM] <file|pattern> [TO] <filename>
[COLSTART <n>) [CASE] [NUMERIC)
Template:            FROM/A, TO/A, COLSTART/K, CASE/S, NUMERIC/S
Purpose:            To alphabetically sort the lines of a file.
Path:            C:SORT
Specification:

SORT will sort the FROM file alphabetically, line by line, sending the
sorted results to the TO file. SORT assumes the file is a normal text
file in which lines are separated by fteturns or line feeds. SORT
normally disregards capitalization. If the CASE switch is given,
capitalized items will be output first.

The COLSTART keyword allows you to specify the character column at
which the comparison will begin. SORT compares the lines from that
point on, and comparison will wrap around to the beginning of the line
if the lines being compared match to the end.

When the NUMERIC option is specified, the lines are interpreted as
numbers from the first column reading to the right, stopping at the
first non-numeric character. Lines not beginning with numbers are
treated as 0. The lines are output in numerical order. If the CASE
switch is given with NUMERlC, CASE is ignored.


Example:

    1> SORT DF0:Glossary DF0:Glossary.alpha

sorts the lines in the Glossary file, arranges them alphabetically, and
outputs them to a new file called Glossary.alpha. The case of the words
is disregarded.
SOUND


Format:        SOUND [FROM <filename>] [EDIT] [USE] [SAVE]
[PUBSCREEN <public screen name>]
Template:            FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K
Purpose:        To control type of sound and sound attributes
produced by Amiga.
Path:            Extras:Prefs/Sound
Specifcation:

The Sound editor allows you to determine the type of sound and its
attributes that you want your Amiga to produce when the system issues
an application prompt or error notification.

SOUND without any arguments or with the EDIT argument opens the Sound
editor. The FROM argument lets you specify a file to open. This must be
a file that was previously saved with the Save As menu item of the
Sound editor. For example, if you have saved a special configuration of
the Sound editor to a file in the Presets drawer, you can use the FROM
argument to open that file. If the USE switch is also given, the editor
will not be opened, but the settings in the FROM file will be used. If
the SAVE switch is given, the editor will not open, but the settings in
the FROM file will be saved.
STACK


Format:            STACK [<stack size>]
Template:            SIZE/N
Purpose:        To display or set the stack size within the current
Shell.
Path:            Internal
Specifcation:

When you run a program, it uses a certain amount of stack, a special
area in memory allocated for the program. The stack required for a
program should be given in the program's documentation. However, if a
program causes a system failure, you may wish to experiment with
various stack sizes.

Commands that perform operations that consist of multiple levels may
require additional stack space.

Stack sizes generally range from 4000 to 25,000 bytes. If the stack
size is too small, a system failure may occur. Too large of a stack
size may take too much memory away from other system functions.

CautionIf you  run out of stack space, you  may receive a Software
Failure message. If you have altered the stack for the
program that caused the Software Failure message, try
increasing the stack size.
STATUS


Format:        STATUS [<process>] [FULL] [TCB] [CLI|ALL] [COMMAND
<command>]
Template:        PROCESS/N, FULL/S, TCB/S, CLl=ALL/S, COM=COMMAND/K
Purpose:            To list information about Shell/CLl processes.
Path:            C:STATUS
Specifcation:

STATUS without any arguments lists the numbers of the cunent Shell/CLl
processes and the program or command, if any, running in each. The
<process> argument specifies a process number, and STATUS will only
give information about that process.

For information on the stacksize, global vector size, priority, and
current command for each process, use the FULL keyword. The TCB keyword
is similar, but omits the command information.

With the COMMAND option, you can tell STATUS to search for a command.
STATUS then scans the Shell list, looking for the specified <command>.
If the command is found, the Shell number is output, and the condition
flag is set to 0. Otherwise the flag is set to 5 (WARN). This is useful
in script files.


Example 1:

    1> STATUS 1
    Process 1: Loaded as command: status


Example 2:

    1> STATUS 1 FULL
    Process 1: stk 4000, gv 150, pri 0 Loaded as command: status


Example 3:

    1> STATUS >RAM:Xyz COMMAND=COPY
    1> BREAK <RAM:Xyz  >NIL: ?

sends a break to the process executing COPY.


See Also: BREAK
TIME


Format:            TIME [EDIT] [SAVE] [PUBSCREEN <public screen name>]
Template:            EDIT/S, SAVE/S, PUBSCREEN/K
Purpose:            To set the system clock.
Path:            Extras:Prefs/Time
Specifcation:

TIME without any arguments or with the EDIT argument opens the Time
editor.

The SAVE option causes the current system time to be saved to the
battery backed-up clock, similar to SETCLOCK SAVE.
TYPE


Format:        TYPE (<file|pattern>} [TO <name>] [OPT H|N] [HEX]
[NUMBER]
Template:            FROM/A/M, TO/K, OPT/K, HEX/S, NUMBER/S
Purpose:            To display a text file.
Path:            C:TYPE
Specification:

TYPE will output the contents of the named file to the current window,
if no destination is given, or to a specified output file. If more than
one filename is specified, and the TO keyword is not used, the
filenames will be typed in sequence.

The OPT H and OPT N options are also available by the HEX and NUMBER
keywords, respectively. The HEX option causes the file to be typed as
columns of hexadecimal numbers, with an ASCII character interpretation
column. This is useful for analyzing object files. The NUMBER option
will number the lines as they are output.

To pause output, press the Space bar. To resume output, press
Backspace, Return, or Ctrl+X. To stop output, press Ctrl+C (***BREAK is
displayed).


Example:

    1> TYPE DEVS:MountList

The contents of the MountList file in the DEVS: directory will be
displayed on the screen.
UNALIAS


Format:            UNALIAS [<name>]
Template:            NAME
Purpose:            To remove an alias.
Path:            Internal
Specification:

UNALIAS removes the named alias from the alias list.

With no arguments, UNALIAS lists the current aliases.


See also: ALIAS
UNSET


Format:            UNSET [<name>]
Template:            NAME
Purpose:            To remove a local variable.
Path:            Internal
Specifcation:

UNSET removes the named local vaxiable from the variable list for the
current process.

With no arguments, UNSET lists the current variables.


See also: SET
UNSETENV


Format:            UNSETENV [<name>]
Template:            NAME
Purpose:            To remove a global variable.
Path:            Internal
Specification:

UNSETENV removes the named global variable from the current variable
list.

With no arguments, UNSETENV lists the current variables.


See also: SETENV
VERSION


Format:        VERSION [<library|device|file>][<version #>]
[<revision #>] [<unit #>]
Template:        NAME, VERSION/N, REVISION/N, UNIT/N, FILE/S,
INTERNAL/S, RES/S, FULL/S
Purpose:            To find software version and revision numbers.
Path:            C:VERSION
Specifcation:

VERSION finds the version and revision number of a library, device,
command, or Workbench disk. VERSION can also test for a specific
version/revision and set the condition flags if the version/revision is
greater. This is useful in scripts.

VERSION with no <library|device|file> argument prints the Kickstart
version number and the Workbench version number and sets the
environment variables. If a name is specified, version attempts to open
the library, device, drive, or file and read the version information.
You can get the version of the filesystem by specifying a drive name,
such as DF0: or DH0:.

When a <version #> (and possibly a <revision #>) is specified, VERSION
sets the condition flag to 0 if the version (and revision) number of
the Kickstart, library, or device driver is greater than or equal to
the specifed values. Otherwise, the flag is set to 5 (WARN). (lf a
revision number is not specified, no comparison on the revision number
is performed.)

The <unit #> option allows you to specify a unit number other than 0.
This may be necessary for accessing multi-unit devices.

The FILE option forces VERSION to inspect the object as a file, even if
it is a library or device. The INTERNAL and RES options let you get the
version of the Internal and Resident commands, respectively. Built-in
Shell commands will have the same version string as the Shell itself.
INTERNAL can also be used to find the version of a RAM module (library
or drive) without opening the device or library. The FULL option prints
out the complete version string, including the date.


Examples:

    1> VERSION
    Kickstart version 39.92 Workbench version 39.1

    1> VERSION  Prefs/Font
    Prefs/Font version 38.21
WAIT


Format:            WAIT [<n>] [SEC|SECS] [MlN|MINS] [UNTIL <time>]
Template:            /N, SEC=SECS/S, MIN=MINS/S, UNTIL/K
Purpose:            To wait for the specified time.
Path:            C:WAIT
Specification:

WAIT is used in command sequences or after RUN to wait for a certain
period, or to wait until a certain time. Unless you specify otherwise,
the waiting period is one second.

The <n> argument specifies the number of seconds (or minutes, if MINS
is given) to wait.

Use the keyword UNTIL to wait until a particular time of the day, given
in the format HH:MM.


Example 1:

    1>  WAIT 10 MINS

waits ten minutes.


Example 2:

    1> WAIT UNTIL 21:15

waits until 9:15 p.m.
WBPATTERN


Format:        WBPATTERN [FROM <filename>] [EDIT] [USE] [SAVE]
[CLIPUNIT <clipboard unit>]
Template:            FROM, EDiT/S, USE/S, SAVE/S, CLIPUNIT/K/N
Purpose:        To create background patterns for the Workbench and
windows.
Path:            Extras:Prefs/WBPattern
Specification:

WBPATTERN with no arguments or with the EDIT argument opens the
WBPattern editor.

The FROM argument lets you specify a file to open. This must be a file
that was previously saved with the Save As menu item of the WBPattern
editor. For example, if you have saved a special configuration of the
WBPattern editor to a file in the Presets drawer, you can use the FROM
argument to open that file. If the USE switch is also given, the editor
will not be opened, but the settings in the FROM file will be used. If
the SAVE switch is given, the editor will not open, but the settings in
the FROM file will be saved.

CLIPUNIT specifies which Clipboard unit to use during cut and paste
operations.
WHICH


Format:            WHICH <command> [NORES] [RES] [ALL]
Template:            FILE/A, NORES/S, RES/S, ALL/S
Purpose:            To search the command path for a particular item.
Path:            C:WHICH
Specifcation:

WHICH lets you find a particular command, program, or directory by
entering its name. If the named item is in the search path, WHICH
displays the complete path to that item. WHICH lists resident commands
as RESIDENT and internal commands as INTERNAL.

Normally, WHICH searches the resident list, the current directory, the
command path(s), and the C: directory. The condition flag is set to 5
(WARN) if the file is not found.

If the NORES option is specified, the resident list is not searched. If
the RES option is specified, only the resident list is searched.

The ALL switch causes the search to continue through the full search
path, even after one or more examples of the named item have been found
and listed. This ensures that all versions of a command or program are
found. It can, however, lead to multiple listings of the same command,
if that command is reached by more than one route (e.g., C: and the
current directory).


Examples:

    1> WHICH avail
    C:avail

    1> WHICH C:
    Workbench:C

    1> WHICH alias
    INTERNAL alias
WHY


Format:            WHY
Template:            (none)
Purpose:        To print an enor message that explains why the
previous command failed.
Path:            Internal
Specification:

Usually when a command fails the screen displays a brief message. This
message typically includes the name of the file (if that was the
problem) but does not go into detail.

For example, the message "Can't open <filename>" may appear. This could
happen for a number of reasons - AmigaDOS may not be able to locate the
file, the file is of the wrong type, or there was insufficient disk
space or RAM for the operation requested.

If the reason is not immediately obvious, enter WHY to get a more
complete explanation.